opts.c 35 KB
Newer Older
1
/* Command line option handling.
hubicka's avatar
 
hubicka committed
2
   Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc.
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
   Contributed by Neil Booth.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING.  If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.  */

#include "config.h"
#include "system.h"
neil's avatar
neil committed
24
#include "intl.h"
25 26 27
#include "coretypes.h"
#include "tm.h"
#include "tree.h"
neil's avatar
neil committed
28 29 30
#include "rtl.h"
#include "ggc.h"
#include "output.h"
31 32
#include "langhooks.h"
#include "opts.h"
33 34 35
#include "options.h"
#include "flags.h"
#include "toplev.h"
neil's avatar
neil committed
36
#include "params.h"
neil's avatar
neil committed
37
#include "diagnostic.h"
neil's avatar
neil committed
38
#include "tm_p.h"		/* For OPTIMIZATION_OPTIONS.  */
39
#include "insn-attr.h"		/* For INSN_SCHEDULING.  */
40
#include "target.h"
41

neil's avatar
neil committed
42 43 44 45 46 47 48
/* Value of the -G xx switch, and whether it was passed or not.  */
unsigned HOST_WIDE_INT g_switch_value;
bool g_switch_set;

/* True if we should exit after parsing options.  */
bool exit_after_options;

49 50 51 52 53 54 55 56 57 58 59
/* Print various extra warnings.  -W/-Wextra.  */
bool extra_warnings;

/* True to warn about any objects definitions whose size is larger
   than N bytes.  Also want about function definitions whose returned
   values are larger than N bytes, where N is `larger_than_size'.  */
bool warn_larger_than;
HOST_WIDE_INT larger_than_size;

/* Nonzero means warn about constructs which might not be
   strict-aliasing safe.  */
wilson's avatar
wilson committed
60
int warn_strict_aliasing;
61

neil's avatar
neil committed
62 63 64
/* Hack for cooperation between set_Wunused and set_Wextra.  */
static bool maybe_warn_unused_parameter;

neil's avatar
neil committed
65 66 67 68 69 70 71 72 73 74 75 76 77 78
/* Type(s) of debugging information we are producing (if any).  See
   flags.h for the definitions of the different possible types of
   debugging information.  */
enum debug_info_type write_symbols = NO_DEBUG;

/* Level of debugging information we are producing.  See flags.h for
   the definitions of the different possible levels.  */
enum debug_info_level debug_info_level = DINFO_LEVEL_NONE;

/* Nonzero means use GNU-only extensions in the generated symbolic
   debugging information.  Currently, this only has an effect when
   write_symbols is set to DBX_DEBUG, XCOFF_DEBUG, or DWARF_DEBUG.  */
bool use_gnu_debug_info_extensions;

giovannibajo's avatar
giovannibajo committed
79 80 81 82 83 84
/* The default visibility for all symbols (unless overridden) */
enum symbol_visibility default_visibility = VISIBILITY_DEFAULT;

/* Global visibility options.  */
struct visibility_flags visibility_options;

neil's avatar
neil committed
85 86 87 88 89 90
/* Columns of --help display.  */
static unsigned int columns = 80;

/* What to print when a switch has no documentation.  */
static const char undocumented_msg[] = N_("This switch lacks documentation");

hubicka's avatar
 
hubicka committed
91 92 93 94 95
/* Used for bookkeeping on whether user set these flags so
   -fprofile-use/-fprofile-generate does not use them.  */
static bool profile_arc_flag_set, flag_profile_values_set;
static bool flag_unroll_loops_set, flag_tracer_set;
static bool flag_value_profile_transformations_set;
96
bool flag_speculative_prefetching_set;
hubicka's avatar
 
hubicka committed
97 98
static bool flag_peel_loops_set, flag_branch_probabilities_set;

kazu's avatar
kazu committed
99
/* Input file names.  */
bothner's avatar
 
bothner committed
100 101 102
const char **in_fnames;
unsigned num_in_fnames;

103
static size_t find_opt (const char *, int);
104
static int common_handle_option (size_t scode, const char *arg, int value);
neil's avatar
neil committed
105 106
static void handle_param (const char *);
static void set_Wextra (int);
107
static unsigned int handle_option (const char **argv, unsigned int lang_mask);
108 109 110
static char *write_langs (unsigned int lang_mask);
static void complain_wrong_lang (const char *, const struct cl_option *,
				 unsigned int lang_mask);
111
static void handle_options (unsigned int, const char **, unsigned int);
neil's avatar
neil committed
112
static void wrap_help (const char *help, const char *item, unsigned int);
neil's avatar
neil committed
113
static void print_help (void);
neil's avatar
neil committed
114
static void print_param_help (void);
neil's avatar
neil committed
115
static void print_filtered_help (unsigned int flag);
neil's avatar
neil committed
116
static unsigned int print_switch (const char *text, unsigned int indent);
neil's avatar
neil committed
117 118
static void set_debug_level (enum debug_info_type type, int extended,
			     const char *arg);
119 120

/* Perform a binary search to find which option the command-line INPUT
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
   matches.  Returns its index in the option array, and N_OPTS
   (cl_options_count) on failure.

   This routine is quite subtle.  A normal binary search is not good
   enough because some options can be suffixed with an argument, and
   multiple sub-matches can occur, e.g. input of "-pedantic" matching
   the initial substring of "-pedantic-errors".

   A more complicated example is -gstabs.  It should match "-g" with
   an argument of "stabs".  Suppose, however, that the number and list
   of switches are such that the binary search tests "-gen-decls"
   before having tested "-g".  This doesn't match, and as "-gen-decls"
   is less than "-gstabs", it will become the lower bound of the
   binary search range, and "-g" will never be seen.  To resolve this
   issue, opts.sh makes "-gen-decls" point, via the back_chain member,
   to "-g" so that failed searches that end between "-gen-decls" and
   the lexicographically subsequent switch know to go back and see if
   "-g" causes a match (which it does in this example).

   This search is done in such a way that the longest match for the
   front end in question wins.  If there is no match for the current
   front end, the longest match for a different front end is returned
   (or N_OPTS if none) and the caller emits an error message.  */
144
static size_t
145 146
find_opt (const char *input, int lang_mask)
{
147 148
  size_t mn, mx, md, opt_len;
  size_t match_wrong_lang;
149 150 151
  int comp;

  mn = 0;
152
  mx = cl_options_count;
153

154 155 156
  /* Find mn such this lexicographical inequality holds:
     cl_options[mn] <= input < cl_options[mn + 1].  */
  while (mx - mn > 1)
157 158 159
    {
      md = (mn + mx) / 2;
      opt_len = cl_options[md].opt_len;
neil's avatar
neil committed
160
      comp = strncmp (input, cl_options[md].opt_text + 1, opt_len);
161 162 163 164

      if (comp < 0)
	mx = md;
      else
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
	mn = md;
    }

  /* This is the switch that is the best match but for a different
     front end, or cl_options_count if there is no match at all.  */
  match_wrong_lang = cl_options_count;

  /* Backtrace the chain of possible matches, returning the longest
     one, if any, that fits best.  With current GCC switches, this
     loop executes at most twice.  */
  do
    {
      const struct cl_option *opt = &cl_options[mn];

      /* Is this switch a prefix of the input?  */
neil's avatar
neil committed
180
      if (!strncmp (input, opt->opt_text + 1, opt->opt_len))
181
	{
182 183 184 185 186 187 188 189
	  /* If language is OK, and the match is exact or the switch
	     takes a joined argument, return it.  */
	  if ((opt->flags & lang_mask)
	      && (input[opt->opt_len] == '\0' || (opt->flags & CL_JOINED)))
	    return mn;

	  /* If we haven't remembered a prior match, remember this
	     one.  Any prior match is necessarily better.  */
190
	  if (match_wrong_lang == cl_options_count)
191
	    match_wrong_lang = mn;
192
	}
193 194 195 196

      /* Try the next possibility.  This is cl_options_count if there
	 are no more.  */
      mn = opt->back_chain;
197
    }
198
  while (mn != cl_options_count);
199

200 201
  /* Return the best wrong match, or cl_options_count if none.  */
  return match_wrong_lang;
202 203
}

204
/* If ARG is a non-negative integer made up solely of digits, return its
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
   value, otherwise return -1.  */
static int
integral_argument (const char *arg)
{
  const char *p = arg;

  while (*p && ISDIGIT (*p))
    p++;

  if (*p == '\0')
    return atoi (arg);

  return -1;
}

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
/* Return a malloced slash-separated list of languages in MASK.  */
static char *
write_langs (unsigned int mask)
{
  unsigned int n = 0, len = 0;
  const char *lang_name;
  char *result;

  for (n = 0; (lang_name = lang_names[n]) != 0; n++)
    if (mask & (1U << n))
      len += strlen (lang_name) + 1;

  result = xmalloc (len);
  len = 0;
  for (n = 0; (lang_name = lang_names[n]) != 0; n++)
    if (mask & (1U << n))
      {
	if (len)
	  result[len++] = '/';
	strcpy (result + len, lang_name);
	len += strlen (lang_name);
      }

  result[len] = 0;

  return result;
}

/* Complain that switch OPT_INDEX does not apply to this front end.  */
static void
complain_wrong_lang (const char *text, const struct cl_option *option,
		     unsigned int lang_mask)
{
  char *ok_langs, *bad_lang;

  ok_langs = write_langs (option->flags);
  bad_lang = write_langs (lang_mask);

  /* Eventually this should become a hard error IMO.  */
  warning ("command line option \"%s\" is valid for %s but not for %s",
	   text, ok_langs, bad_lang);

  free (ok_langs);
  free (bad_lang);
}

/* Handle the switch beginning at ARGV for the language indicated by
   LANG_MASK.  Returns the number of switches consumed.  */
static unsigned int
269
handle_option (const char **argv, unsigned int lang_mask)
270 271 272 273
{
  size_t opt_index;
  const char *opt, *arg = 0;
  char *dup = 0;
274
  int value = 1;
275
  unsigned int result = 0;
276 277 278 279
  const struct cl_option *option;

  opt = argv[0];

280 281 282
  /* Drop the "no-" from negative switches.  */
  if ((opt[1] == 'W' || opt[1] == 'f')
      && opt[2] == 'n' && opt[3] == 'o' && opt[4] == '-')
283
    {
284 285 286 287 288 289 290 291
      size_t len = strlen (opt) - 3;

      dup = xmalloc (len + 1);
      dup[0] = '-';
      dup[1] = opt[1];
      memcpy (dup + 2, opt + 5, len - 2 + 1);
      opt = dup;
      value = 0;
292 293
    }

294 295 296
  opt_index = find_opt (opt + 1, lang_mask | CL_COMMON);
  if (opt_index == cl_options_count)
    goto done;
297

298
  option = &cl_options[opt_index];
299

300 301 302 303
  /* Reject negative form of switches that don't take negatives as
     unrecognized.  */
  if (!value && (option->flags & CL_REJECT_NEGATIVE))
    goto done;
304

305 306
  /* We've recognized this switch.  */
  result = 1;
307

308 309 310 311 312 313 314 315 316 317 318
  /* Sort out any argument the switch takes.  */
  if (option->flags & CL_JOINED)
    {
      /* Have arg point to the original switch.  This is because
	 some code, such as disable_builtin_function, expects its
	 argument to be persistent until the program exits.  */
      arg = argv[0] + cl_options[opt_index].opt_len + 1;
      if (!value)
	arg += strlen ("no-");

      if (*arg == '\0' && !(option->flags & CL_MISSING_OK))
319
	{
320
	  if (option->flags & CL_SEPARATE)
321
	    {
322 323
	      arg = argv[1];
	      result = 2;
324
	    }
325 326 327
	  else
	    /* Missing argument.  */
	    arg = NULL;
328
	}
329 330 331 332 333 334
    }
  else if (option->flags & CL_SEPARATE)
    {
      arg = argv[1];
      result = 2;
    }
335

336 337 338 339 340 341 342
  /* Now we've swallowed any potential argument, complain if this
     is a switch for a different front end.  */
  if (!(option->flags & (lang_mask | CL_COMMON)))
    {
      complain_wrong_lang (argv[0], option, lang_mask);
      goto done;
    }
343

344 345
  if (arg == NULL && (option->flags & (CL_JOINED | CL_SEPARATE)))
    {
sayle's avatar
 
sayle committed
346
      if (!lang_hooks.missing_argument (opt, opt_index))
347 348 349
	error ("missing argument to \"%s\"", opt);
      goto done;
    }
350

351 352 353 354 355
  /* If the switch takes an integer, convert it.  */
  if (arg && (option->flags & CL_UINTEGER))
    {
      value = integral_argument (arg);
      if (value == -1)
356
	{
neil's avatar
neil committed
357
	  error ("argument to \"%s\" should be a non-negative integer",
358 359
		 option->opt_text);
	  goto done;
360
	}
361
    }
362

rakdver's avatar
rakdver committed
363 364 365 366 367 368 369 370 371 372 373 374 375
  if (option->flag_var)
    {
      if (option->has_set_value)
	{
	  if (value)
	    *option->flag_var = option->set_value;
	  else
	    *option->flag_var = !option->set_value;
	}
      else
	*option->flag_var = value;
    }
  
376
  if (option->flags & lang_mask)
sayle's avatar
 
sayle committed
377
    if (lang_hooks.handle_option (opt_index, arg, value) == 0)
378
      result = 0;
379

380 381 382
  if (result && (option->flags & CL_COMMON))
    if (common_handle_option (opt_index, arg, value) == 0)
      result = 0;
383 384 385 386 387 388

 done:
  if (dup)
    free (dup);
  return result;
}
389

390 391 392 393 394 395 396 397 398
/* Handle FILENAME from the command line.  */
static void
add_input_filename (const char *filename)
{
  num_in_fnames++;
  in_fnames = xrealloc (in_fnames, num_in_fnames * sizeof (in_fnames[0]));
  in_fnames[num_in_fnames - 1] = filename;
}

399 400 401
/* Decode and handle the vector of command line options.  LANG_MASK
   contains has a single bit set representing the current
   language.  */
neil's avatar
neil committed
402
static void
403
handle_options (unsigned int argc, const char **argv, unsigned int lang_mask)
404 405 406 407 408
{
  unsigned int n, i;

  for (i = 1; i < argc; i += n)
    {
409 410 411 412 413
      const char *opt = argv[i];

      /* Interpret "-" or a non-switch as a file name.  */
      if (opt[0] != '-' || opt[1] == '\0')
	{
bothner's avatar
 
bothner committed
414 415
	  if (main_input_filename == NULL)
	    main_input_filename = opt;
bothner's avatar
 
bothner committed
416
	  add_input_filename (opt);
417 418 419 420
	  n = 1;
	  continue;
	}

421 422 423 424 425
      n = handle_option (argv + i, lang_mask);

      if (!n)
	{
	  n = 1;
426
	  error ("unrecognized command line option \"%s\"", opt);
427 428 429 430
	}
    }
}

neil's avatar
neil committed
431 432 433
/* Parse command line options and set default flag values.  Do minimal
   options processing.  */
void
434
decode_options (unsigned int argc, const char **argv)
neil's avatar
neil committed
435
{
436
  unsigned int i, lang_mask;
neil's avatar
neil committed
437 438

  /* Perform language-specific options initialization.  */
sayle's avatar
 
sayle committed
439
  lang_mask = lang_hooks.init_options (argc, argv);
neil's avatar
neil committed
440

441 442
  lang_hooks.initialize_diagnostics (global_dc);

neil's avatar
neil committed
443 444 445 446 447 448 449 450 451 452 453 454
  /* Scan to see what optimization level has been specified.  That will
     determine the default value of many flags.  */
  for (i = 1; i < argc; i++)
    {
      if (!strcmp (argv[i], "-O"))
	{
	  optimize = 1;
	  optimize_size = 0;
	}
      else if (argv[i][0] == '-' && argv[i][1] == 'O')
	{
	  /* Handle -Os, -O2, -O3, -O69, ...  */
455
	  const char *p = &argv[i][2];
neil's avatar
neil committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495

	  if ((p[0] == 's') && (p[1] == 0))
	    {
	      optimize_size = 1;

	      /* Optimizing for size forces optimize to be 2.  */
	      optimize = 2;
	    }
	  else
	    {
	      const int optimize_val = read_integral_parameter (p, p - 2, -1);
	      if (optimize_val != -1)
		{
		  optimize = optimize_val;
		  optimize_size = 0;
		}
	    }
	}
    }

  if (!optimize)
    {
      flag_merge_constants = 0;
    }

  if (optimize >= 1)
    {
      flag_defer_pop = 1;
      flag_thread_jumps = 1;
#ifdef DELAY_SLOTS
      flag_delayed_branch = 1;
#endif
#ifdef CAN_DEBUG_WITHOUT_FP
      flag_omit_frame_pointer = 1;
#endif
      flag_guess_branch_prob = 1;
      flag_cprop_registers = 1;
      flag_loop_optimize = 1;
      flag_if_conversion = 1;
      flag_if_conversion2 = 1;
dnovillo's avatar
 
dnovillo committed
496 497 498 499 500 501 502 503
      flag_tree_ccp = 1;
      flag_tree_dce = 1;
      flag_tree_dom = 1;
      flag_tree_dse = 1;
      flag_tree_ter = 1;
      flag_tree_live_range_split = 1;
      flag_tree_sra = 1;
      flag_tree_copyrename = 1;
dnovillo's avatar
 
dnovillo committed
504
      flag_tree_fre = 1;
dnovillo's avatar
 
dnovillo committed
505 506 507 508 509 510 511 512

      if (!optimize_size)
	{
	  /* Loop header copying usually increases size of the code.  This used
	     not to be true, since quite often it is possible to verify that
	     the condition is satisfied in the first iteration and therefore
	     to eliminate it.  Jump threading handles these cases now.  */
	  flag_tree_ch = 1;
dnovillo's avatar
 
dnovillo committed
513 514 515
 
          /* PRE tends to generate bigger code.  */
          flag_tree_pre = 1;
dnovillo's avatar
 
dnovillo committed
516
	}
neil's avatar
neil committed
517 518 519 520
    }

  if (optimize >= 2)
    {
hubicka's avatar
 
hubicka committed
521
      flag_crossjumping = 1;
neil's avatar
neil committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
      flag_optimize_sibling_calls = 1;
      flag_cse_follow_jumps = 1;
      flag_cse_skip_blocks = 1;
      flag_gcse = 1;
      flag_expensive_optimizations = 1;
      flag_strength_reduce = 1;
      flag_rerun_cse_after_loop = 1;
      flag_rerun_loop_opt = 1;
      flag_caller_saves = 1;
      flag_force_mem = 1;
      flag_peephole2 = 1;
#ifdef INSN_SCHEDULING
      flag_schedule_insns = 1;
      flag_schedule_insns_after_reload = 1;
#endif
      flag_regmove = 1;
      flag_strict_aliasing = 1;
      flag_delete_null_pointer_checks = 1;
      flag_reorder_blocks = 1;
      flag_reorder_functions = 1;
hubicka's avatar
 
hubicka committed
542
      flag_unit_at_a_time = 1;
neil's avatar
neil committed
543 544 545 546 547 548
    }

  if (optimize >= 3)
    {
      flag_inline_functions = 1;
      flag_unswitch_loops = 1;
549
      flag_gcse_after_reload = 1;
neil's avatar
neil committed
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
    }

  if (optimize < 2 || optimize_size)
    {
      align_loops = 1;
      align_jumps = 1;
      align_labels = 1;
      align_functions = 1;

      /* Don't reorder blocks when optimizing for size because extra
	 jump insns may be created; also barrier may create extra padding.

	 More correctly we should have a block reordering mode that tried
	 to minimize the combined size of all the jumps.  This would more
	 or less automatically remove extra jumps, but would also try to
	 use more short jumps instead of long jumps.  */
      flag_reorder_blocks = 0;
567
      flag_reorder_blocks_and_partition = 0;
neil's avatar
neil committed
568 569
    }

570 571 572 573 574 575 576
  if (optimize_size)
    {
      /* Inlining of very small functions usually reduces total size.  */
      set_param_value ("max-inline-insns-single", 5);
      set_param_value ("max-inline-insns-auto", 5);
      set_param_value ("max-inline-insns-rtl", 10);
      flag_inline_functions = 1;
577 578 579

      /* We want to crossjump as much as possible.  */
      set_param_value ("min-crossjump-insns", 1);
580 581
    }

neil's avatar
neil committed
582 583
  /* Initialize whether `char' is signed.  */
  flag_signed_char = DEFAULT_SIGNED_CHAR;
584 585 586
  /* Set this to a special "uninitialized" value.  The actual default is set
     after target options have been processed.  */
  flag_short_enums = 2;
neil's avatar
neil committed
587 588 589 590 591 592

  /* Initialize target_flags before OPTIMIZATION_OPTIONS so the latter can
     modify it.  */
  target_flags = 0;
  set_target_switch ("");

593 594 595 596
  /* Unwind tables are always present when a target has ABI-specified unwind
     tables, so the default should be ON.  */
#ifdef TARGET_UNWIND_INFO
  flag_unwind_tables = TARGET_UNWIND_INFO;
neil's avatar
neil committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
#endif

#ifdef OPTIMIZATION_OPTIONS
  /* Allow default optimizations to be specified on a per-machine basis.  */
  OPTIMIZATION_OPTIONS (optimize, optimize_size);
#endif

  handle_options (argc, argv, lang_mask);

  if (flag_pie)
    flag_pic = flag_pie;
  if (flag_pic && !flag_pie)
    flag_shlib = 1;

  if (flag_no_inline == 2)
    flag_no_inline = 0;
  else
    flag_really_no_inline = flag_no_inline;

  /* Set flag_no_inline before the post_options () hook.  The C front
     ends use it to determine tree inlining defaults.  FIXME: such
     code should be lang-independent when all front ends use tree
     inlining, in which case it, and this condition, should be moved
     to the top of process_options() instead.  */
  if (optimize == 0)
    {
      /* Inlining does not work if not optimizing,
	 so force it not to be done.  */
      flag_no_inline = 1;
      warn_inline = 0;

      /* The c_decode_option function and decode_option hook set
	 this to `2' if -Wall is used, so we can avoid giving out
	 lots of errors for people who don't realize what -Wall does.  */
      if (warn_uninitialized == 1)
	warning ("-Wuninitialized is not supported without -O");
    }

  if (flag_really_no_inline == 2)
    flag_really_no_inline = flag_no_inline;
637 638 639 640 641 642 643 644 645 646 647 648 649

  /* The optimization to partition hot and cold basic blocks into separate
     sections of the .o and executable files does not work (currently)
     with exception handling.  If flag_exceptions is turned on we need to
     turn off the partitioning optimization.  */

  if (flag_exceptions && flag_reorder_blocks_and_partition)
    {
      warning 
	    ("-freorder-blocks-and-partition does not work with exceptions");
      flag_reorder_blocks_and_partition = 0;
      flag_reorder_blocks = 1;
    }
650 651 652 653 654 655

  /* The optimization to partition hot and cold basic blocks into
     separate sections of the .o and executable files does not currently
     work correctly with DWARF debugging turned on.  Until this is fixed
     we will disable the optimization when DWARF debugging is set.  */
  
656
  if (flag_reorder_blocks_and_partition && write_symbols == DWARF2_DEBUG)
657 658 659 660 661 662
    {
      warning
	("-freorder-blocks-and-partition does not work with -g (currently)");
      flag_reorder_blocks_and_partition = 0;
      flag_reorder_blocks = 1;
    }
neil's avatar
neil committed
663 664
}

665
/* Handle target- and language-independent options.  Return zero to
rakdver's avatar
rakdver committed
666 667 668 669
   generate an "unknown option" message.  Only options that need
   extra handling need to be listed here; if you simply want
   VALUE assigned to a variable, it happens automatically.  */

670
static int
rakdver's avatar
rakdver committed
671
common_handle_option (size_t scode, const char *arg, int value)
672 673 674 675 676
{
  enum opt_code code = (enum opt_code) scode;

  switch (code)
    {
neil's avatar
neil committed
677
    case OPT__help:
neil's avatar
neil committed
678
      print_help ();
neil's avatar
neil committed
679 680 681
      exit_after_options = true;
      break;

neil's avatar
neil committed
682 683 684 685
    case OPT__param:
      handle_param (arg);
      break;

neil's avatar
neil committed
686 687 688 689 690 691 692 693 694 695 696
    case OPT__target_help:
      display_target_options ();
      exit_after_options = true;
      break;

    case OPT__version:
      print_version (stderr, "");
      exit_after_options = true;
      break;

    case OPT_G:
697
      g_switch_value = value;
neil's avatar
neil committed
698 699 700
      g_switch_set = true;
      break;

neil's avatar
neil committed
701 702 703 704 705 706 707 708 709 710 711 712 713 714
    case OPT_O:
    case OPT_Os:
      /* Currently handled in a prescan.  */
      break;

    case OPT_W:
      /* For backward compatibility, -W is the same as -Wextra.  */
      set_Wextra (value);
      break;

    case OPT_Wextra:
      set_Wextra (value);
      break;

715 716 717 718 719 720
    case OPT_Wlarger_than_:
      larger_than_size = value;
      warn_larger_than = value != -1;
      break;

    case OPT_Wstrict_aliasing:
wilson's avatar
wilson committed
721
    case OPT_Wstrict_aliasing_:
722 723 724
      warn_strict_aliasing = value;
      break;

neil's avatar
neil committed
725 726 727 728
    case OPT_Wunused:
      set_Wunused (value);
      break;

neil's avatar
neil committed
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
    case OPT_aux_info:
    case OPT_aux_info_:
      aux_info_file_name = arg;
      flag_gen_aux_info = 1;
      break;

    case OPT_auxbase:
      aux_base_name = arg;
      break;

    case OPT_auxbase_strip:
      {
	char *tmp = xstrdup (arg);
	strip_off_ending (tmp, strlen (tmp));
	if (tmp[0])
	  aux_base_name = tmp;
      }
      break;

    case OPT_d:
      decode_d_option (arg);
      break;

    case OPT_dumpbase:
      dump_base_name = arg;
      break;

756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
    case OPT_falign_functions_:
      align_functions = value;
      break;

    case OPT_falign_jumps_:
      align_jumps = value;
      break;

    case OPT_falign_labels_:
      align_labels = value;
      break;

    case OPT_falign_loops_:
      align_loops = value;
      break;

neil's avatar
neil committed
772
    case OPT_fbranch_probabilities:
hubicka's avatar
 
hubicka committed
773
      flag_branch_probabilities_set = true;
774 775
      break;

neil's avatar
neil committed
776 777 778 779 780 781 782 783
    case OPT_fcall_used_:
      fix_register (arg, 0, 1);
      break;

    case OPT_fcall_saved_:
      fix_register (arg, 0, 0);
      break;

neil's avatar
neil committed
784 785 786 787 788 789 790 791 792 793
    case OPT_fdiagnostics_show_location_:
      if (!strcmp (arg, "once"))
	diagnostic_prefixing_rule (global_dc) = DIAGNOSTICS_SHOW_PREFIX_ONCE;
      else if (!strcmp (arg, "every-line"))
	diagnostic_prefixing_rule (global_dc)
	  = DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE;
      else
	return 0;
      break;

dnovillo's avatar
 
dnovillo committed
794 795 796 797 798
    case OPT_fdump_:
      if (!dump_switch_p (arg))
	return 0;
      break;

neil's avatar
neil committed
799 800 801 802 803 804 805 806
    case OPT_ffast_math:
      set_fast_math_flags (value);
      break;

    case OPT_ffixed_:
      fix_register (arg, 1, 1);
      break;

neil's avatar
neil committed
807 808 809 810 811 812 813
    case OPT_finline_limit_:
    case OPT_finline_limit_eq:
      set_param_value ("max-inline-insns-single", value / 2);
      set_param_value ("max-inline-insns-auto", value / 2);
      set_param_value ("max-inline-insns-rtl", value);
      break;

neil's avatar
neil committed
814
    case OPT_fmessage_length_:
815
      pp_set_line_maximum_length (global_dc->printer, value);
neil's avatar
neil committed
816 817
      break;

rth's avatar
rth committed
818 819 820 821 822 823 824 825 826 827
    case OPT_fpack_struct_:
      if (value <= 0 || (value & (value - 1)) || value > 16)
	error("structure alignment must be a small power of two, not %d", value);
      else
	{
	  initial_max_fld_align = value;
	  maximum_field_alignment = value * BITS_PER_UNIT;
	}
      break;

neil's avatar
neil committed
828
    case OPT_fpeel_loops:
hubicka's avatar
 
hubicka committed
829
      flag_peel_loops_set = true;
neil's avatar
neil committed
830 831 832
      break;

    case OPT_fprofile_arcs:
hubicka's avatar
 
hubicka committed
833
      profile_arc_flag_set = true;
neil's avatar
neil committed
834 835
      break;

hubicka's avatar
 
hubicka committed
836 837 838 839 840 841 842 843 844 845 846 847 848
    case OPT_fprofile_use:
      if (!flag_branch_probabilities_set)
        flag_branch_probabilities = value;
      if (!flag_profile_values_set)
        flag_profile_values = value;
      if (!flag_unroll_loops_set)
        flag_unroll_loops = value;
      if (!flag_peel_loops_set)
        flag_peel_loops = value;
      if (!flag_tracer_set)
        flag_tracer = value;
      if (!flag_value_profile_transformations_set)
        flag_value_profile_transformations = value;
849
#ifdef HAVE_prefetch
850
      if (0 && !flag_speculative_prefetching_set)
851 852
	flag_speculative_prefetching = value;
#endif
hubicka's avatar
 
hubicka committed
853 854 855 856 857 858 859 860 861
      break;

    case OPT_fprofile_generate:
      if (!profile_arc_flag_set)
        profile_arc_flag = value;
      if (!flag_profile_values_set)
        flag_profile_values = value;
      if (!flag_value_profile_transformations_set)
        flag_value_profile_transformations = value;
862 863
      if (!flag_unroll_loops_set)
	flag_unroll_loops = value;
864
#ifdef HAVE_prefetch
865
      if (0 && !flag_speculative_prefetching_set)
866 867
	flag_speculative_prefetching = value;
#endif
hubicka's avatar
 
hubicka committed
868 869
      break;

870
    case OPT_fprofile_values:
hubicka's avatar
 
hubicka committed
871
      flag_profile_values_set = true;
872 873
      break;

giovannibajo's avatar
giovannibajo committed
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
    case OPT_fvisibility_:
      {
        if (!strcmp(arg, "default"))
          default_visibility = VISIBILITY_DEFAULT;
        else if (!strcmp(arg, "internal"))
          default_visibility = VISIBILITY_INTERNAL;
        else if (!strcmp(arg, "hidden"))
          default_visibility = VISIBILITY_HIDDEN;
        else if (!strcmp(arg, "protected"))
          default_visibility = VISIBILITY_PROTECTED;
        else
          error ("unrecognised visibility value \"%s\"", arg);
      }
      break;

889
    case OPT_fvpt:
890 891 892 893 894
      flag_value_profile_transformations_set = true;
      break;

    case OPT_fspeculative_prefetching:
      flag_speculative_prefetching_set = true;
895 896
      break;

neil's avatar
neil committed
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
    case OPT_frandom_seed:
      /* The real switch is -fno-random-seed.  */
      if (value)
	return 0;
      flag_random_seed = NULL;
      break;

    case OPT_frandom_seed_:
      flag_random_seed = arg;
      break;

    case OPT_fsched_verbose_:
#ifdef INSN_SCHEDULING
      fix_sched_param ("verbose", arg);
      break;
#else
      return 0;
#endif

916 917 918 919 920 921 922 923 924
    case OPT_fsched_stalled_insns_:
      flag_sched_stalled_insns = value;
      if (flag_sched_stalled_insns == 0)
	flag_sched_stalled_insns = -1;
      break;

    case OPT_fsched_stalled_insns_dep_:
      flag_sched_stalled_insns_dep = value;
      break;
neil's avatar
neil committed
925

neil's avatar
neil committed
926 927 928 929 930 931 932
    case OPT_fstack_limit:
      /* The real switch is -fno-stack-limit.  */
      if (value)
	return 0;
      stack_limit_rtx = NULL_RTX;
      break;

neil's avatar
neil committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
    case OPT_fstack_limit_register_:
      {
	int reg = decode_reg_name (arg);
	if (reg < 0)
	  error ("unrecognized register name \"%s\"", arg);
	else
	  stack_limit_rtx = gen_rtx_REG (Pmode, reg);
      }
      break;

    case OPT_fstack_limit_symbol_:
      stack_limit_rtx = gen_rtx_SYMBOL_REF (Pmode, ggc_strdup (arg));
      break;

    case OPT_ftls_model_:
      if (!strcmp (arg, "global-dynamic"))
	flag_tls_default = TLS_MODEL_GLOBAL_DYNAMIC;
      else if (!strcmp (arg, "local-dynamic"))
	flag_tls_default = TLS_MODEL_LOCAL_DYNAMIC;
      else if (!strcmp (arg, "initial-exec"))
	flag_tls_default = TLS_MODEL_INITIAL_EXEC;
      else if (!strcmp (arg, "local-exec"))
	flag_tls_default = TLS_MODEL_LOCAL_EXEC;
      else
	warning ("unknown tls-model \"%s\"", arg);
      break;

neil's avatar
neil committed
960
    case OPT_ftracer:
hubicka's avatar
 
hubicka committed
961
      flag_tracer_set = true;
dnovillo's avatar
 
dnovillo committed
962 963
      break;

neil's avatar
neil committed
964
    case OPT_funroll_loops:
hubicka's avatar
 
hubicka committed
965
      flag_unroll_loops_set = true;
neil's avatar
neil committed
966 967
      break;

968
    case OPT_g:
neil's avatar
neil committed
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995
      set_debug_level (NO_DEBUG, DEFAULT_GDB_EXTENSIONS, arg);
      break;

    case OPT_gcoff:
      set_debug_level (SDB_DEBUG, false, arg);
      break;

    case OPT_gdwarf_2:
      set_debug_level (DWARF2_DEBUG, false, arg);
      break;

    case OPT_ggdb:
      set_debug_level (NO_DEBUG, 2, arg);
      break;

    case OPT_gstabs:
    case OPT_gstabs_:
      set_debug_level (DBX_DEBUG, code == OPT_gstabs_, arg);
      break;

    case OPT_gvms:
      set_debug_level (VMS_DEBUG, false, arg);
      break;

    case OPT_gxcoff:
    case OPT_gxcoff_:
      set_debug_level (XCOFF_DEBUG, code == OPT_gxcoff_, arg);
996 997
      break;

neil's avatar
neil committed
998 999 1000 1001
    case OPT_m:
      set_target_switch (arg);
      break;

neil's avatar
neil committed
1002 1003 1004 1005 1006 1007 1008 1009
    case OPT_o:
      asm_file_name = arg;
      break;

    case OPT_pedantic_errors:
      flag_pedantic_errors = pedantic = 1;
      break;

rakdver's avatar
rakdver committed
1010 1011 1012
    default:
      /* If the flag was handled in a standard way, assume the lack of
	 processing here is intentional.  */
1013 1014 1015 1016
      if (cl_options[scode].flag_var)
	break;

      abort ();
1017 1018 1019 1020
    }

  return 1;
}
neil's avatar
neil committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036

/* Handle --param NAME=VALUE.  */
static void
handle_param (const char *carg)
{
  char *equal, *arg;
  int value;

  arg = xstrdup (carg);
  equal = strchr (arg, '=');
  if (!equal)
    error ("%s: --param arguments should be of the form NAME=VALUE", arg);
  else
    {
      value = integral_argument (equal + 1);
      if (value == -1)
1037
	error ("invalid --param value %qs", equal + 1);
neil's avatar
neil committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
      else
	{
	  *equal = '\0';
	  set_param_value (arg, value);
	}
    }

  free (arg);
}

/* Handle -W and -Wextra.  */
static void
set_Wextra (int setting)
{
  extra_warnings = setting;
  warn_unused_value = setting;
  warn_unused_parameter = (setting && maybe_warn_unused_parameter);

  /* We save the value of warn_uninitialized, since if they put
     -Wuninitialized on the command line, we need to generate a
     warning about not using it without also specifying -O.  */
  if (setting == 0)
    warn_uninitialized = 0;
  else if (warn_uninitialized != 1)
    warn_uninitialized = 2;
}

/* Initialize unused warning flags.  */
void
set_Wunused (int setting)
{
  warn_unused_function = setting;
  warn_unused_label = setting;
  /* Unused function parameter warnings are reported when either
     ``-Wextra -Wunused'' or ``-Wunused-parameter'' is specified.
     Thus, if -Wextra has already been seen, set warn_unused_parameter;
     otherwise set maybe_warn_extra_parameter, which will be picked up
     by set_Wextra.  */
  maybe_warn_unused_parameter = setting;
  warn_unused_parameter = (setting && extra_warnings);
  warn_unused_variable = setting;
  warn_unused_value = setting;
}
neil's avatar
neil committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091

/* The following routines are useful in setting all the flags that
   -ffast-math and -fno-fast-math imply.  */
void
set_fast_math_flags (int set)
{
  flag_trapping_math = !set;
  flag_unsafe_math_optimizations = set;
  flag_finite_math_only = set;
  flag_errno_math = !set;
  if (set)
sayle's avatar
 
sayle committed
1092 1093 1094 1095
    {
      flag_signaling_nans = 0;
      flag_rounding_math = 0;
    }
neil's avatar
neil committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
}

/* Return true iff flags are set as if -ffast-math.  */
bool
fast_math_flags_set_p (void)
{
  return (!flag_trapping_math
	  && flag_unsafe_math_optimizations
	  && flag_finite_math_only
	  && !flag_errno_math);
}
neil's avatar
neil committed
1107

neil's avatar
neil committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161
/* Handle a debug output -g switch.  EXTENDED is true or false to support
   extended output (2 is special and means "-ggdb" was given).  */
static void
set_debug_level (enum debug_info_type type, int extended, const char *arg)
{
  static bool type_explicit;

  use_gnu_debug_info_extensions = extended;

  if (type == NO_DEBUG)
    {
      if (write_symbols == NO_DEBUG)
	{
	  write_symbols = PREFERRED_DEBUGGING_TYPE;

	  if (extended == 2)
	    {
#ifdef DWARF2_DEBUGGING_INFO
	      write_symbols = DWARF2_DEBUG;
#elif defined DBX_DEBUGGING_INFO
	      write_symbols = DBX_DEBUG;
#endif
	    }

	  if (write_symbols == NO_DEBUG)
	    warning ("target system does not support debug output");
	}
    }
  else
    {
      /* Does it conflict with an already selected type?  */
      if (type_explicit && write_symbols != NO_DEBUG && type != write_symbols)
	error ("debug format \"%s\" conflicts with prior selection",
	       debug_type_names[type]);
      write_symbols = type;
      type_explicit = true;
    }

  /* A debug flag without a level defaults to level 2.  */
  if (*arg == '\0')
    {
      if (!debug_info_level)
	debug_info_level = 2;
    }
  else
    {
      debug_info_level = integral_argument (arg);
      if (debug_info_level == (unsigned int) -1)
	error ("unrecognised debug output level \"%s\"", arg);
      else if (debug_info_level > 3)
	error ("debug output level %s is too high", arg);
    }
}

neil's avatar
neil committed
1162 1163 1164
/* Output --help text.  */
static void
print_help (void)
neil's avatar
neil committed
1165 1166
{
  size_t i;
neil's avatar
neil committed
1167 1168 1169 1170 1171 1172 1173 1174 1175
  const char *p;

  GET_ENVIRONMENT (p, "COLUMNS");
  if (p)
    {
      int value = atoi (p);
      if (value > 0)
	columns = value;
    }
neil's avatar
neil committed
1176 1177 1178 1179

  puts (_("The following options are language-independent:\n"));

  print_filtered_help (CL_COMMON);
neil's avatar
neil committed
1180
  print_param_help ();
neil's avatar
neil committed
1181 1182 1183

  for (i = 0; lang_names[i]; i++)
    {
neil's avatar
neil committed
1184
      printf (_("The %s front end recognizes the following options:\n\n"),
neil's avatar
neil committed
1185 1186 1187 1188
	      lang_names[i]);
      print_filtered_help (1U << i);
    }

neil's avatar
neil committed
1189
  display_target_options ();
neil's avatar
neil committed
1190 1191
}

neil's avatar
neil committed
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216
/* Print the help for --param.  */
static void
print_param_help (void)
{
  size_t i;

  puts (_("The --param option recognizes the following as parameters:\n"));

  for (i = 0; i < LAST_PARAM; i++)
    {
      const char *help = compiler_params[i].help;
      const char *param = compiler_params[i].option;

      if (help == NULL || *help == '\0')
	help = undocumented_msg;

      /* Get the translation.  */
      help = _(help);

      wrap_help (help, param, strlen (param));
    }

  putchar ('\n');
}

neil's avatar
neil committed
1217 1218 1219
/* Print help for a specific front-end, etc.  */
static void
print_filtered_help (unsigned int flag)
neil's avatar
neil committed
1220
{
neil's avatar
neil committed
1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
  unsigned int i, len, filter, indent = 0;
  bool duplicates = false;
  const char *help, *opt, *tab;
  static char *printed;

  if (flag == CL_COMMON)
    {
      filter = flag;
      if (!printed)
	printed = xmalloc (cl_options_count);
      memset (printed, 0, cl_options_count);
    }
  else
    {
      /* Don't print COMMON options twice.  */
      filter = flag | CL_COMMON;
neil's avatar
neil committed
1237

neil's avatar
neil committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
      for (i = 0; i < cl_options_count; i++)
	{
	  if ((cl_options[i].flags & filter) != flag)
	    continue;

	  /* Skip help for internal switches.  */
	  if (cl_options[i].flags & CL_UNDOCUMENTED)
	    continue;

	  /* Skip switches that have already been printed, mark them to be
	     listed later.  */
	  if (printed[i])
	    {
	      duplicates = true;
	      indent = print_switch (cl_options[i].opt_text, indent);
	    }
	}

      if (duplicates)
	{
	  putchar ('\n');
	  putchar ('\n');
	}
    }
neil's avatar
neil committed
1262 1263 1264

  for (i = 0; i < cl_options_count; i++)
    {
neil's avatar
neil committed
1265 1266 1267
      if ((cl_options[i].flags & filter) != flag)
	continue;

1268 1269 1270 1271
      /* Skip help for internal switches.  */
      if (cl_options[i].flags & CL_UNDOCUMENTED)
	continue;

neil's avatar
neil committed
1272 1273 1274 1275 1276 1277
      /* Skip switches that have already been printed.  */
      if (printed[i])
	continue;

      printed[i] = true;

neil's avatar
neil committed
1278
      help = cl_options[i].help;
neil's avatar
neil committed
1279
      if (!help)
neil's avatar
neil committed
1280
	help = undocumented_msg;
neil's avatar
neil committed
1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299

      /* Get the translation.  */
      help = _(help);

      tab = strchr (help, '\t');
      if (tab)
	{
	  len = tab - help;
	  opt = help;
	  help = tab + 1;
	}
      else
	{
	  opt = cl_options[i].opt_text;
	  len = strlen (opt);
	}

      wrap_help (help, opt, len);
    }
neil's avatar
neil committed
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327

  putchar ('\n');
}

/* Output ITEM, of length ITEM_WIDTH, in the left column, followed by
   word-wrapped HELP in a second column.  */
static unsigned int
print_switch (const char *text, unsigned int indent)
{
  unsigned int len = strlen (text) + 1; /* trailing comma */

  if (indent)
    {
      putchar (',');
      if (indent + len > columns)
	{
	  putchar ('\n');
	  putchar (' ');
	  indent = 1;
	}
    }
  else
    putchar (' ');

  putchar (' ');
  fputs (text, stdout);

  return indent + len + 1;
neil's avatar
neil committed
1328 1329 1330 1331 1332
}

/* Output ITEM, of length ITEM_WIDTH, in the left column, followed by
   word-wrapped HELP in a second column.  */
static void
neil's avatar
neil committed
1333
wrap_help (const char *help, const char *item, unsigned int item_width)
neil's avatar
neil committed
1334
{
neil's avatar
neil committed
1335
  unsigned int col_width = 27;
1336
  unsigned int remaining, room, len;
neil's avatar
neil committed
1337 1338 1339 1340 1341 1342

  remaining = strlen (help);

  do
    {
      room = columns - 3 - MAX (col_width, item_width);
neil's avatar
neil committed
1343 1344
      if (room > columns)
	room = 0;
neil's avatar
neil committed
1345 1346 1347 1348
      len = remaining;

      if (room < len)
	{
1349
	  unsigned int i;
neil's avatar
neil committed
1350 1351 1352 1353 1354 1355 1356

	  for (i = 0; help[i]; i++)
	    {
	      if (i >= room && len != remaining)
		break;
	      if (help[i] == ' ')
		len = i;
neil's avatar
neil committed
1357 1358
	      else if ((help[i] == '-' || help[i] == '/')
		       && help[i + 1] != ' '
1359
		       && i > 0 && ISALPHA (help[i - 1]))
neil's avatar
neil committed
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
		len = i + 1;
	    }
	}

      printf( "  %-*.*s %.*s\n", col_width, item_width, item, len, help);
      item_width = 0;
      while (help[len] == ' ')
	len++;
      help += len;
      remaining -= len;
    }
  while (remaining);
}