ghc/driver/ghc.lprl

   1 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1997
   2 %
   3
   4 This is the driver script for the Glasgow Haskell compilation system.
   5 It is written in \tr{perl}.  The first section includes a long
   6 ``usage'' message that describes how the driver is supposed to work.
   7
   8 %************************************************************************
   9 %*                                                                      *
  10 \section[Driver-usage]{Usage message}
  11 %*                                                                      *
  12 %************************************************************************
  13
  14 \begin{code}
  15 ($Pgm = $0) =~ s|.*/||;
  16 $ShortUsage  =  "\nUsage: For basic information, try the `-help' option.\n";
  17 $LongUsage = "\n" . <<EOUSAGE;
  18 Use of the Glorious Haskell Compilation System driver:
  19
  20     $Pgm [command-line-options-and-input-files]
  21
  22 ------------------------------------------------------------------------
  23 This driver ($Pgm) guides each input file through (some of the)
  24 possible phases of a compilation:
  25
  26     - unlit:    extract code from a "literate program"
  27     - hscpp:    run code through the C pre-processor (if -cpp flag given)
  28     - hsc:      run the Haskell compiler proper
  29     - gcc:      run the C compiler (if compiling via C)
  30     - as:       run the assembler
  31     - ld:       run the linker
  32
  33 For each input file, the phase to START with is determined by the
  34 file's suffix:
  35     - .lhs      literate Haskell: unlit
  36     - .hs       illiterate Haskell: hsc
  37     - .hc       C from the Haskell compiler: gcc
  38     - .c        C not from the Haskell compiler: gcc
  39     - .s        assembly language: as
  40     - other     passed directly to the linker: ld
  41
  42 If no files are given on the command line, input is taken from
  43 standard input, and processing is as for an .hs file.  (All output is
  44 to stdout or stderr, however).
  45
  46 The phase at which to STOP processing is determined by a command-line
  47 option:
  48     -E          stop after generating preprocessed, de-litted Haskell (used in conjunction with -cpp)
  49     -C          stop after generating C (.hc output)
  50     -S          stop after generating assembler (.s output)
  51     -c          stop after generating object files (.o output)
  52
  53 Other commonly-used options are:
  54
  55     -O          An `optimising' package of compiler flags, for faster code
  56
  57     -prof       Compile for cost-centre profiling
  58                 (add -auto for automagic cost-centres on top-level functions)
  59
  60     -fglasgow-exts  Allow Glasgow extensions (unboxed types, etc.)
  61
  62     -H14m       Increase compiler's heap size
  63
  64     -M          Output the Makefile rules recording the
  65                 dependencies of a list of Haskell files.
  66                 (ghc driver script calls upon the help of a
  67                  compatible mkdependHS script to do the actual
  68                  processing)
  69
  70 The User's Guide has more information about GHC's *many* options.
  71
  72 Given the above, here are some TYPICAL invocations of $Pgm:
  73
  74     # compile a Haskell module to a .o file, optimising:
  75     % $Pgm -c -O Foo.hs
  76     # link three .o files into an executable called "test":
  77     % $Pgm -o test Foo.o Bar.o Baz.o
  78     # compile a Haskell module to C (a .hc file), using a bigger heap:
  79     % $Pgm -C -H16m Foo.hs
  80     # compile Haskell-produced C (.hc) to assembly language:
  81     % $Pgm -S Foo.hc
  82 ------------------------------------------------------------------------
  83 EOUSAGE
  84 \end{code}
  85
  86 %************************************************************************
  87 %*                                                                      *
  88 \section[Driver-init]{Initialisation}
  89 %*                                                                      *
  90 %************************************************************************
  91
  92 The driver script need to be told where to find these executables, so
  93 in the course of building the driver `executable', make-variables holding
  94 these are prepended to the de-litted version of this file. The variables are:
  95
  96 \begin{verbatim}
  97 INSTALLING
  98
  99 HOSTPLATFORM TARGETPLATFORM
 100
 101 ProjectName ProjectVersion ProjectVersionInt ProjectPatchLevel
 102
 103 HscMajorVersion HscMinorVersion CcMajorVersion CcMinorVersion
 104
 105 TOP_PWD
 106
 107 bindir libdir libexecdir datadir
 108
 109 CURRENT_DIR TMPDIR
 110
 111 GHC_LIB_DIR GHC_RUNTIME_DIR GHC_UTILS_DIR GHC_INCLUDE_DIR
 112
 113 GHC_OPT_HILEV_ASM GhcWithNativeCodeGen
 114
 115 GHC_UNLIT GHC_HSCPP GHC_HSC GHC_SYSMAN
 116
 117 CP RM CONTEXT_DIFF
 118
 119 WAY_*_NAME WAY_*_HC_OPTS
 120
 121 LeadingUnderscore
 122
 123 \end{verbatim}
 124
 125 Establish what executables to run for the various phases, what the
 126 default options are for those phases, and other similar boring stuff.
 127
 128 \begin{code}
 129 select(STDERR); $| = 1; select(STDOUT); # no STDERR buffering, please.
 130
 131 $TargetPlatform = $TARGETPLATFORM;
 132
 133 $TopPwd            = "${TOP_PWD}";
 134 $InstBinDirGhc     = "${bindir}";
 135 $InstLibDirGhc     = "${libdir}";
 136 #
 137 # Normally the same as InstLibDirGhc, but we accommodate
 138 # for it being separate.
 139 #
 140 $InstLibExecDirGhc = "${libexecdir}";
 141 $InstDataDirGhc    = "${datadir}";
 142
 143 $Status  = 0; # just used for exit() status
 144 $Verbose = '';
 145
 146 # set up signal handler
 147 sub quit_upon_signal { &tidy_up_and_die(1, ''); }
 148 $SIG{'INT'}  = 'quit_upon_signal';
 149 $SIG{'QUIT'} = 'quit_upon_signal';
 150
 151 # where to get "require"d .prl files at runtime (poor man's dynamic loading)
 152 #   (use LIB, not DATA, because we can't be sure of arch-independence)
 153 @INC = ( ( $INSTALLING ) ? $InstLibDirGhc
 154                            : "$TopPwd/${CURRENT_DIR}" );
 155
 156 if ( $ENV{'TMPDIR'} ) { # where to make tmp file names
 157     $Tmp_prefix = ($ENV{'TMPDIR'} . "/ghc$$");
 158 } else {
 159     print STDERR "TMPDIR has not been set to anything useful!\n" if (${TMPDIR} eq '');
 160     $Tmp_prefix ="${TMPDIR}/ghc$$"; # TMPDIR set via Makefile when booting..
 161     $ENV{'TMPDIR'} = ${TMPDIR}; # set the env var as well
 162 }
 163
 164 # Some shells run into real trouble when command line and environment
 165 # gets big (e.g., cmd lines of >4K to /bin/sh causes havoc on our
 166 # Solaris-2.5.1 boxes - even though sysconf(_SC_ARG_MAX) reports 1M ...).
 167 # To work around any such */bin/sh* problems, we will scribble such
 168 # awfully long command lines into a temp file and exec that temp file
 169 # with $(REAL_SHELL) (don't use the SHELL variable directly as this
 170 # will normally get you the wrong thing when the driver is invoked
 171 # from within `make'). If the REAL_SHELL variable isn't set, you'll
 172 # get SHELL. This is all a terrible hack. (in case you hadn't reached
 173 # the same conclusion by now :-)
 174 #
 175 # TBC..
 176 #
 177 if ( ! $ENV{'REAL_SHELL'} ) {
 178     $ENV{'REAL_SHELL'} = $ENV{'SHELL'};
 179 }
 180
 181 @Files_to_tidy = (); # files we nuke in the case of abnormal termination
 182
 183 $Unlit = ( $INSTALLING ) ? "$InstLibExecDirGhc/unlit"
 184                          : "$TopPwd/${CURRENT_DIR}/${GHC_UNLIT}";
 185
 186 $Cp   = $CP;
 187 $Rm   = $RM;
 188 $Diff = $CONTEXT_DIFF;
 189 $Cat  = 'cat';
 190 $Cmp  = 'cmp';
 191 $Time = '';
 192
 193 $HsCpp   = # but this is re-set to "cat" (after options) if -cpp not seen
 194            ( $INSTALLING ) ? "$InstLibExecDirGhc/hscpp"
 195                            : "$TopPwd/${CURRENT_DIR}/${GHC_HSCPP}";
 196
 197 @HsCpp_flags    = ();
 198 $HsC     = ( $INSTALLING ) ? "$InstLibExecDirGhc/hsc"
 199                            : "$TopPwd/${CURRENT_DIR}/${GHC_HSC}";
 200
 201 # For PVM fiends only
 202 $SysMan  = ( $INSTALLING ) ? "$InstLibExecDirGhc/SysMan"
 203                            : "$TopPwd/${CURRENT_DIR}/${GHC_SYSMAN}";
 204
 205 @Unlit_flags    = ();
 206
 207 #
 208 # HsC_rts_flags: if we want to talk to the LML runtime system
 209 # NB: we don't use powers-of-2 sizes, because this may do
 210 #   terrible things to cache behavior.
 211 #
 212 $Specific_heap_size = 6 * 1000 * 1000;
 213 $Specific_stk_size  = 1000 * 1000;
 214 $Scale_sizes_by     = 1.0;
 215
 216 \end{code}
 217
 218 The variables set by @setupOptFlags@ represent parts of the
 219 -O/-O2/etc ``templates,'' which are filled in later, using these.
 220 These are the default values, which may be changed by user flags.
 221
 222 \begin{code}
 223 sub setupOptFlags {
 224    $Oopt_MaxSimplifierIterations  = '-fmax-simplifier-iterations4';
 225    $Oopt_PedanticBottoms          = '-fpedantic-bottoms'; # ON by default
 226    $Oopt_MonadEtaExpansion        = '';
 227    $Oopt_FinalStgProfilingMassage = '';
 228    $Oopt_StgStats                 = '';
 229    $Oopt_DoSpecialise             = '-fspecialise';
 230    $Oopt_FoldrBuild               = 0; # *Off* by default!
 231    $Oopt_FB_Support               = ''; # was '-fdo-arity-expand';
 232 #  $Oopt_FoldrBuildWW             = 0; # Off by default
 233    $Oopt_FoldrBuildInline         = ''; # was '-fdo-inline-foldr-build';
 234    $Oopt_ShowSimplifierProgress   = '';
 235 } # end of setupOptFlags
 236
 237 # Assign defaults to these right away.
 238 &setupOptFlags();
 239 \end{code}
 240
 241 Things to do with C compilers/etc:
 242
 243 (added -Wimplicit: implicit prototypes cause very hard-to-find
 244 problems, so I'm turing on the warnings -- SDM 4/5/98)
 245
 246 \begin{code}
 247 $CcRegd         = $GHC_OPT_HILEV_ASM;
 248 @CcBoth_flags   = ('-S','-Wimplicit');   # flags for *any* C compilation
 249 @CcInjects      = ();
 250
 251 # GCC flags:
 252 #    those for all files,
 253 #    those only for .c files;
 254 #    those only for .hc files
 255
 256 @CcRegd_flags    = ();
 257 @CcRegd_flags_c  = ();
 258 @CcRegd_flags_hc = ();
 259
 260 $As              = ''; # "assembler" is normally GCC
 261 @As_flags        = ();
 262
 263 $Lnkr            = ''; # "linker" is normally GCC
 264 @Ld_flags        = ();
 265
 266 # 'nm' is used for consistency checking (ToDo: mk-world-ify)
 267 # ToDo: check the OS or something ("alpha" is surely not the crucial question)
 268 $Nm = ($TargetPlatform =~ /^alpha-/) ? 'nm -B' : 'nm';
 269 \end{code}
 270
 271 Warning packages that are controlled by -W and -Wall.  The 'standard'
 272 warnings that you get all the time are
 273
 274         -fwarn-overlapping-patterns
 275         -fwarn-missing-methods
 276         -fwarn-duplicate-exports
 277
 278 these are turned off by -Wnot.
 279
 280 \begin{code}
 281 @StandardWarnings = ('-fwarn-overlapping-patterns',
 282                      '-fwarn-missing-methods',
 283                      '-fwarn-duplicate-exports');
 284 @MinusWOpts       = (@StandardWarnings,
 285                      '-fwarn-incomplete-patterns',
 286                      '-fwarn-unused-binds',
 287                      '-fwarn-unused-imports');
 288 @MinusWallOpts    = (@MinusWOpts,
 289                      '-fwarn-unused-matches',
 290                      '-fwarn-type-defaults',
 291                      '-fwarn-name-shadowing',
 292                      '-fwarn-missing-signatures');
 293 \end{code}
 294
 295 What options \tr{-user-setup-a} turn into (user-defined ``packages''
 296
 297 of options).  Note that a particular user-setup implies a particular
 298 Prelude ({\em including} its interface file(s)).
 299 \begin{code}
 300 $BuildTag       = ''; # default is sequential build w/ Appel-style GC
 301
 302 %BuildDescr     = (# system ways begin
 303                    '',      'normal sequential',
 304                    '_p',    "$WAY_p_NAME",
 305                    '_t',    "$WAY_t_NAME",
 306                    '_u',    "$WAY_u_NAME",
 307                    '_mp',   "$WAY_mp_NAME",
 308                    '_mg',   "$WAY_mg_NAME",
 309                    # system ways end
 310                    '_a',    "$WAY_a_NAME",
 311                    '_b',    "$WAY_b_NAME",
 312                    '_c',    "$WAY_c_NAME",
 313                    '_d',    "$WAY_d_NAME",
 314                    '_e',    "$WAY_e_NAME",
 315                    '_f',    "$WAY_f_NAME",
 316                    '_g',    "$WAY_g_NAME",
 317                    '_h',    "$WAY_h_NAME",
 318                    '_i',    "$WAY_i_NAME",
 319                    '_j',    "$WAY_j_NAME",
 320                    '_k',    "$WAY_k_NAME",
 321                    '_l',    "$WAY_l_NAME",
 322                    '_m',    "$WAY_m_NAME",
 323                    '_n',    "$WAY_n_NAME",
 324                    '_o',    "$WAY_o_NAME",
 325                    '_A',    "$WAY_A_NAME",
 326                    '_B',    "$WAY_B_NAME" );
 327
 328 # these are options that are "fed back" through the option processing loop
 329 #
 330 %SetupOpts =
 331        (
 332         '_a', "$WAY_a_HC_OPTS",
 333         '_b', "$WAY_b_HC_OPTS",
 334         '_c', "$WAY_c_HC_OPTS",
 335         '_d', "$WAY_d_HC_OPTS",
 336         '_e', "$WAY_e_HC_OPTS",
 337         '_f', "$WAY_f_HC_OPTS",
 338         '_g', "$WAY_g_HC_OPTS",
 339         '_h', "$WAY_h_HC_OPTS",
 340         '_i', "$WAY_i_HC_OPTS",
 341         '_j', "$WAY_j_HC_OPTS",
 342         '_k', "$WAY_k_HC_OPTS",
 343         '_l', "$WAY_l_HC_OPTS",
 344         '_m', "$WAY_m_HC_OPTS",
 345         '_n', "$WAY_n_HC_OPTS",
 346         '_o', "$WAY_o_HC_OPTS",
 347         '_A', "$WAY_A_HC_OPTS",
 348         '_B', "$WAY_B_HC_OPTS",
 349
 350         # system ways
 351         '_p',  "$WAY_p_HC_OPTS",
 352         '_t',  "$WAY_t_HC_OPTS",
 353         '_u',  "$WAY_u_HC_OPTS",
 354         '_mp', "$WAY_mp_HC_OPTS",
 355         '_mg', "$WAY_mg_HC_OPTS");
 356
 357 \end{code}
 358
 359 Import/include directories (\tr{-I} options) are sufficiently weird to
 360 require special handling.
 361
 362 \begin{code}
 363 @Import_dir     = ('.'); #-i things
 364 @Include_dir    = ('.'); #-I things; other default(s) stuck on AFTER option processing
 365
 366 # where to look for interface files (system hi's, i.e., prelude and syslibs)
 367 @SysImport_dir  = ( $INSTALLING )
 368                     ? ( "$InstLibDirGhc/imports/std" )
 369                     : ( "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std" );
 370
 371 # We need to look in ghc/ and glaExts/ when searching for implicitly needed .hi files, but
 372 # we should really *not* look there for explicitly imported modules.
 373
 374 $Haskell1Version = 5; # i.e., Haskell 1.4
 375 @Cpp_define      = ();
 376
 377 # Cpp symbols defined when we're processing Haskell source.
 378
 379 @HsSourceCppOpts =
 380         ( "-D__HASKELL1__=$Haskell1Version"
 381         , "-D__GLASGOW_HASKELL__=$ProjectVersionInt"
 382         # not yet -- SDM
 383         # , "-D__CONCURRENT_HASKELL__"
 384         );
 385
 386 @UserLibrary_dir= ();   #-L things;...
 387 @UserLibrary    = ();   #-l things asked for by the user
 388
 389 @SysLibrary_dir = ( ( $INSTALLING )     #-syslib things supplied by the system
 390                     ? $InstLibDirGhc
 391                     : ( "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR"
 392                       , "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/gmp"
 393                       , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std"
 394                       , "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/std/cbits"
 395                       )
 396                   );
 397 @SysLibrary = (); # will be built up as we go along
 398
 399 $TopClosureFile # defaults to 1.2 one; will be mangled later
 400         = '';
 401 #       ( $INSTALLING)  ? "$InstLibDirGhc/TopClosureXXXX.o"
 402 #                         : "$TopPwd/$CURRENT_DIR/$GHC_RUNTIME_DIR/main/TopClosureXXXX.o";
 403
 404 # make depend for Haskell
 405 $MkDependHS
 406         = ( $INSTALLING ) ? "$InstBinDirGhc/mkdependHS"
 407                           : "$TopPwd/$CURRENT_DIR/$GHC_UTILS_DIR/mkdependHS/mkdependHS";
 408 # Fill in later
 409 @MkDependHS_flags = ();
 410
 411 # do_link flag should not be reset while rescanning the cmd-line.
 412 $Do_lnkr    = 1;
 413 $Specific_output_dir = '';      # set by -odir <dir>
 414 $Specific_output_file = '';     # set by -o <file>; "-" for stdout
 415 \end{code}
 416
 417 Function to initialise the per-compilation-unit globals that
 418 are used to guide and control the invocation of the different phases.
 419
 420 \begin{code}
 421 sub initDriverGlobals {
 422
 423 # reset the following options:
 424 # RTS flags to use while compiling
 425 @HsC_rts_flags      = ();
 426 @HsP_flags      = (); # these are the flags destined solely for
 427                       # the flex/yacc parser
 428 @HsC_flags      = ();
 429 @HsC_antiflags  = ();
 430 \end{code}
 431
 432 The optimisations/etc to be done by the compiler are {\em normally}
 433 expressed with a \tr{-O} (or \tr{-O2}) flag, or by its absence.
 434
 435 \begin{code}
 436 $OptLevel      = 0; # no -O == 0; -O == 1; -O2 == 2; -Ofile == 3
 437 $MinusO2ForC   = 0; # set to 1 if -O2 should be given to C compiler
 438 $StolenX86Regs = 4; # **HACK*** of the very worst sort
 439 $CoreLint      = '';
 440 $StgLint       = '';
 441
 442 @Import_dir     = ('.'); #-i things
 443 @Include_dir    = ('.'); #-I things; other default(s) stuck on AFTER option processing
 444
 445
 446 \end{code}
 447
 448 We are given a list of files with various presumably-known suffixes
 449 (unknown-suffix files go straight to the linker).  For each file, we
 450 begin by assuming that we'll run every phase over it.  However: (1)
 451 global flags (\tr{-c}, \tr{-S}, etc.) tell us not to run any phase
 452 past a certain point; and (2) the file's suffix tells us what phase to
 453 start with.  Linking is weird and kept track of separately.
 454
 455 Here are the initial defaults applied to all files:
 456 \begin{code}
 457 $Cpp_flag_set = 0;        # (hack)
 458 $Only_preprocess_C = 0;   # pretty hackish
 459 $Only_preprocess_hc = 0;  # ditto
 460 $Only_generate_deps = 0;  # "
 461 $PostprocessCcOutput = 0;
 462
 463 # native code-gen or via C?
 464 $HaveNativeCodeGen = $GhcWithNativeCodeGen;
 465 $HscOut = '-C='; # '-C=' ==> .hc output; '-S=' ==> .s output; '-N=' ==> neither
 466 $HscOut = '-S='
 467     if $HaveNativeCodeGen && $TargetPlatform =~ /^(alpha)-/;
 468 # TEMP: disable x86 & Sparc if $HaveNativeCodeGen && $TargetPlatform =~ /^(i386|alpha|sparc)-/;
 469 $ProduceHi    = '-hifile=';
 470 $HiOnStdout   = 0;
 471 $HiWith       = '';
 472 $HiDiff_flag  = '';
 473 $Keep_HiDiffs = 0;
 474
 475 $CollectingGCstats = 0;
 476 $CollectGhcTimings = 0;
 477 $DEBUGging = '';        # -DDEBUG and all that it entails (um... not really)
 478 $PROFing = '';          # set to p or e if profiling
 479 $PROFgroup = '';        # set to group if an explicit -Ggroup specified
 480 $PROFauto = '';         # set to relevant hsc flag if -auto or -auto-all
 481 $PROFcaf  = '';         # set to relevant hsc flag if -caf-all
 482 $PROFignore_scc = '';   # set to relevant parser flag if explicit sccs ignored
 483 $UNPROFscc_auto = '';   # set to relevant hsc flag if forcing auto sccs without profiling
 484 $TICKYing = '';         # set to t if compiling for ticky-ticky profiling
 485 $PARing = '';           # set to p if compiling for PAR
 486 $GRANing = '';          # set to g if compiling for GRAN
 487 $Specific_hi_file = '';         # set by -ohi <file>; "-" for stdout
 488 $Specific_dump_file = '';       # set by -odump <file>; "-" for stdout
 489 $Using_dump_file = 0;
 490 $Isuffix    = '';
 491 $Osuffix    = '';       # default: use the normal suffix for that kind of output
 492 $HiSuffix   = 'hi';
 493 $HiSuffix_prelude = '';
 494 $Do_recomp_chkr = 0;    # don't use the recompilatio checker unless asked
 495 $Do_cc      = -1;   # a MAGIC indeterminate value; will be set to 1 or 0.
 496 $Do_as      = 1;
 497
 498 $Keep_hc_file_too = 0;
 499 $Keep_s_file_too = 0;
 500 $UseGhcInternals = 0; # if 1, may use GHC* modules
 501 $SplitObjFiles = 0;
 502 $DoAsmMangling = 1; # on by default, off by -fno-asm-mangling
 503 $NoOfSplitFiles = 0;
 504 $Dump_parser_output = 0;
 505 $Dump_raw_asm = 0;
 506 $Dump_asm_splitting_info = 0;
 507 $NoImplicitPrelude = 0;
 508 # 1 => don't tell the linker to hoist in PrelMain.Main, as an
 509 # external main is provided instead.
 510 $NoHaskellMain=0;
 511
 512 } # end of initDriverGlobals (Sigh)
 513
 514 # we split the argv passed to the driver into three:
 515
 516 # the list of files
 517 @Input_file = ();
 518
 519 # and files to be linked...
 520 @Link_file  = ();
 521
 522 # and whatever else
 523 @Cmd_opts  = ();
 524
 525 # cmd line options prefixing the unit we're compiling
 526 @File_options = ();
 527
 528 \end{code}
 529
 530 We inject consistency-checking information into \tr{.hc} files (both
 531 when created by the Haskell compiler and when compiled by the C
 532 compiler), so that we can check that an executable is made from
 533 consistently-built pieces.  (The check is normally done just after
 534 linking.)  The checking is done by introducing/munging
 535 \tr{what(1)}-style strings.  Anyway, here are the relevant global
 536 variables and their defaults:
 537 \begin{code}
 538 $LinkChk = 0;   # set to 0 if the link check should *not* be done
 539
 540 # major & minor version numbers; major numbers must always agree;
 541 # minor disagreements yield a warning.
 542 $HsC_major_version = $HscMajorVersion;
 543 $HsC_minor_version = $HscMinorVersion;
 544 $Cc_major_version  = $CcMajorVersion;
 545 $Cc_minor_version  = $CcMinorVersion;
 546
 547 # options: these must always agree
 548 $HsC_consist_options = '';    # we record, in this order:
 549                               #     Build tag; debugging?
 550 $Cc_consist_options  = '';    # we record, in this order:
 551                               #     Build tag; debugging?
 552 \end{code}
 553
 554 %************************************************************************
 555 %*                                                                      *
 556 \section[Driver-parse-argv]{Munge the command-line options}
 557 %*                                                                      *
 558 %************************************************************************
 559
 560 Now slurp through the arguments.
 561 \begin{code}
 562
 563 &initDriverGlobals();
 564 &splitCmdLine(@ARGV);
 565 # Run through the cmd-line first time.
 566 &processArgs(@Cmd_opts);
 567
 568 # Check to see if driver is only in the business
 569 # to generate dependencies
 570 if (  $Status == 0 && $Only_generate_deps ) {
 571
 572     push (@MkDependHS_flags, "-o$Osuffix") if $Osuffix;
 573     push (@MkDependHS_flags, "-s$BuildTag") if $BuildTag;
 574     # They're not (currently) needed, but we need to quote any -#include options
 575     foreach (@Cmd_opts) {
 576         s/-#include.*$/'$&'/g;
 577     };
 578     local($to_do) = "$MkDependHS @MkDependHS_flags @HsSourceCppOpts -- @Cmd_opts -- @Input_file" ;
 579     &run_something($to_do, 'Haskell dependencies');
 580     exit $Status;
 581 }
 582
 583 # if there are several input files,
 584 # we don't allow \tr{-o <file>} or \tr{-ohi <file>} options...
 585 # (except if linking, of course)
 586
 587 if ($#Input_file > 0 && ( ! $Do_lnkr )) {
 588     if ( ($Specific_output_file ne '' && $Specific_output_file ne '-')
 589       || ($Specific_hi_file ne ''     && $Specific_hi_file ne '-') ) {
 590         print STDERR "$Pgm: You can't use -o or -ohi options if you have multiple input files.\n";
 591         print STDERR "\tPerhaps the -odir option will do what you want.\n";
 592         $Status++;
 593     }
 594 }
 595
 596 # check for various pathological -o and -odir combinations...
 597 if ($Specific_output_dir ne '' && $Specific_output_file ne '') {
 598     if ($Specific_output_file eq '-') {
 599         print STDERR "$Pgm: can't set output directory with -ohi AND have output to stdout\n";
 600         $Status++;
 601     } else { # amalgamate...
 602         $Specific_output_file = "$Specific_output_dir/$Specific_output_file";
 603         # ToDo: check we haven't got a junk name now...
 604         $Specific_output_dir  = ''; # reset
 605     }
 606 }
 607
 608 # crash and burn if there were errors
 609 if ( $Status > 0 ) {
 610     print STDERR $ShortUsage;
 611     exit $Status;
 612 }
 613 \end{code}
 614
 615 %************************************************************************
 616 %*                                                                      *
 617 \section[Driver-post-argv-mangling]{Setup after reading options}
 618 %*                                                                      *
 619 %************************************************************************
 620
 621 %************************************************************************
 622 %*                                                                      *
 623 \subsection{Set up for optimisation level (\tr{-O} or whatever)}
 624 %*                                                                      *
 625 %************************************************************************
 626
 627 We come now to the default ``wads of options'' that are turned on by
 628 \tr{-O0} (do min optimisation), \tr{-O} (ordinary optimisation),
 629 \tr{-O2} (aggressive optimisation), or no O-ish flag (compile speed is
 630 more important).
 631
 632 The user can also specify his/her own list of options in a file; in
 633 that case, the work is already done (see stuff about @minusO3@,
 634 earlier...).
 635
 636 GHC allows very precise control of what happens during a compilation.
 637 Core-to-Core and STG-to-STG passes can be run in any order, as many
 638 times as you like.  Individual transformations can be turned on or
 639 disabled.
 640
 641 Sadly, however, there are some interdependencies \& Things You Must
 642 Not Do.  Here is the list.
 643
 644 CORE-TO-CORE PASSES:
 645 \begin{description}
 646 \item[\tr{-fspecialise}:]
 647 The specialiser must have dependency-analysed input; but if you run
 648 the simplifier to do this, you must not let it toss away unused
 649 bindings!  (The typechecker conveys some specialisation info via
 650 ``unused'' bindings...)
 651
 652 \item[\tr{-ffloat-inwards}:]
 653 Floating inwards should be done before strictness analysis, because
 654 the latter will give better results.
 655
 656 \item[\tr{-fstatic-args}:]
 657 The static-arguments-transformation pass {\em must} have the
 658 simplifier run right after it.
 659
 660 \item[\tr{-fcalc-inlinings[12]}:]
 661 Not required, but there may be slight gains by re-simplifying after
 662 this is done.  (You could then \tr{-fcalc-inlinings} again, just for
 663 fun.)
 664
 665 \item[\tr{-ffull-laziness}:]
 666 The (outwards-)let-floater should be the {\em last} Core-to-Core pass
 667 that's run.  (Um, well, howzabout the simplifier just once more...)
 668 \end{description}
 669
 670 STG-TO-STG PASSES:
 671 \begin{description}
 672 \item[\tr{-fupdate-analysis}:]
 673 It really really wants to be the last STG-to-STG pass that is run.
 674 \end{description}
 675
 676 \begin{code}
 677
 678 sub setupOptimiseFlags {
 679
 680    @HsC_minusNoO_flags
 681     = ( '-fsimplify',
 682           '[',
 683           $Oopt_FB_Support,
 684           '-ffloat-lets-exposing-whnf',
 685           '-ffloat-primops-ok',
 686           '-fcase-of-case',
 687           '-fdo-case-elim',
 688 #         '-fdo-lambda-eta-expansion',  # too complicated
 689           '-freuse-con',
 690 #         '-flet-to-case',              # no strictness analysis, so...
 691           $Oopt_PedanticBottoms,
 692 #         $Oopt_MonadEtaExpansion,      # no thanks
 693
 694 # These two work fine, if you really want no simplification at all,
 695 # for bizarre test reasons.  But you get really terrible code if you use them,
 696 #       for example: let x = e in x
 697 # with dozens of redundant thunks etc.  So I'm leaving them out.
 698 #
 699 #         '-fsimpl-uf-use-threshold0',
 700 #         '-fessential-unfoldings-only',
 701
 702           #
 703           # The presence of -fclone-binds is *temporary* to work around
 704           # the fact that the desugarer in 3.0{2.3} does generate
 705           # bindings with identical ids, and the type checker doesn't perform
 706           # properly cloned type substitutions. Instead, we make sure that all
 707           # binders are cloned first time through the simplifier.
 708           #
 709           # Will be properly fixed in the `new compiler` I hear, at which point
 710           # the cloning can be turned off here.
 711           #
 712           # Let's find out..
 713           #'-fclone-binds',
 714
 715           $Oopt_MaxSimplifierIterations,
 716           $Oopt_ShowSimplifierProgress,
 717           ']',
 718         $Oopt_AddAutoSccs,
 719 #       '-ffull-laziness',      # removed 95/04 WDP following Andr\'e's lead
 720
 721         $Oopt_FinalStgProfilingMassage
 722       );
 723
 724    @HsC_minusO_flags # NOTE: used for *both* -O and -O2 (some conditional bits)
 725     = (
 726         '-fdo-eta-reduction',
 727
 728         # initial simplify: mk specialiser happy: minimum effort please
 729         '-fsimplify',
 730           '[',
 731           $Oopt_FB_Support,
 732           '-fkeep-spec-pragma-ids',     # required before specialisation
 733
 734 # I don't understand why we want -fessential-unfoldings-only here
 735 # If we have it, the following nasty thing happens:
 736 #       f  = E
 737 #       g* = f
 738 #       ...g...
 739 # where "*" means exported.
 740 # In the essential-unfoldings pass we still substitute f for g
 741 # but we don't substitute E for f first.  So we get
 742 #       f  = E
 743 #       g* = f
 744 #       ...f...
 745 # The g=f will get reverse-substituted later, but it's untidy. --SLPJ
 746 #
 747 # SDM: Here's why it's necessary.
 748 #
 749 #   If we unfold in the first pass before the specialiser is run
 750 #   we miss opportunities for specialisation because eg. wrappers
 751 #   have been inlined for specialisable functions.
 752 #
 753 #   This shows up in PrelArr.lhs - the specialised instance for newArray
 754 #   calls the generic rangeSize, because rangeSize is strict and is
 755 #   replaced by its wrapper by the simplifier.
 756
 757           '-fessential-unfoldings-only',
 758           '-fsimpl-uf-use-threshold0',
 759
 760           # See remark re: cloning in defn of minusnotO
 761           '-fclone-binds',
 762
 763           '-fdo-case-elim',
 764           '-fmax-simplifier-iterations1',
 765           $Oopt_PedanticBottoms,
 766           ']',
 767
 768         ($Oopt_DoSpecialise) ? (
 769           $Oopt_DoSpecialise,
 770         ) : (),
 771
 772         '-fsimplify',           # need dependency anal after specialiser ...
 773           '[',                  # need tossing before calc-inlinings ...
 774           $Oopt_FB_Support,
 775           '-ffloat-lets-exposing-whnf',
 776           '-ffloat-primops-ok',
 777           '-fcase-of-case',
 778           '-fdo-case-elim',
 779           '-fcase-merge',
 780 #         '-fdo-eta-reduction',
 781           '-fdo-lambda-eta-expansion',
 782           '-freuse-con',
 783           $Oopt_PedanticBottoms,
 784           $Oopt_MonadEtaExpansion,
 785           $Oopt_MaxSimplifierIterations,
 786           $Oopt_ShowSimplifierProgress,
 787           #
 788           # The presence of -fclone-binds is *crucial* here as
 789           # -ffull-laziness (which we're about to do next) floats
 790           # bindings outwards, so we better make sure that this
 791           # doesn't result in the floating out of bindings
 792           # with identical uniques, i.e., -ffull-laziness needs
 793           # to be preceeded by a simplifier pass with -fclone-binds
 794           # set.
 795           '-fclone-binds',
 796           ']',
 797
 798 #       ($Oopt_FoldrBuildWW) ? (
 799 #               '-ffoldr-build-ww-anal',
 800 #               '-ffoldr-build-worker-wrapper',
 801 #               '-fsimplify',
 802 #                 '[',
 803 #                 $Oopt_FB_Support,
 804 #                 '-ffloat-lets-exposing-whnf',
 805 #                 '-ffloat-primops-ok',
 806 #                 '-fcase-of-case',
 807 #                 '-fdo-case-elim',
 808 #                 '-fcase-merge',
 809 #                 '-fdo-eta-reduction',
 810 #                 '-fdo-lambda-eta-expansion',
 811 #                 '-freuse-con',
 812 #                 $Oopt_PedanticBottoms,
 813 #                 $Oopt_MonadEtaExpansion,
 814 #                 $Oopt_MaxSimplifierIterations,
 815 #                 $Oopt_ShowSimplifierProgress,
 816 #                 ']',
 817 #        ) : (),
 818
 819         # this pass-ordering sequence was agreed by Simon and Andr\'e
 820         # (WDP 94/07, 94/11).
 821         '-ffull-laziness',
 822
 823         ($Oopt_FoldrBuild) ? (
 824           '-ffoldr-build-on',           # desugar list comprehensions for foldr/build
 825
 826           '-fsimplify',
 827             '[',
 828             '-fignore-inline-pragma',   # **** NB!
 829             '-fdo-foldr-build',         # NB
 830             $Oopt_FB_Support,
 831             '-ffloat-lets-exposing-whnf',
 832             '-ffloat-primops-ok',
 833             '-fcase-of-case',
 834             '-fdo-case-elim',
 835             '-fcase-merge',
 836 #           '-fdo-eta-reduction',
 837             '-fdo-lambda-eta-expansion',        # After full laziness
 838             '-freuse-con',
 839             $Oopt_PedanticBottoms,
 840             $Oopt_MonadEtaExpansion,
 841             $Oopt_MaxSimplifierIterations,
 842             $Oopt_ShowSimplifierProgress,
 843             ']',
 844         ) : (),
 845
 846         '-ffloat-inwards',
 847
 848         '-fsimplify',
 849           '[',
 850           $Oopt_FB_Support,
 851           '-ffloat-lets-exposing-whnf',
 852           '-ffloat-primops-ok',
 853           '-fcase-of-case',
 854           '-fdo-case-elim',
 855           '-fcase-merge',
 856           '-fdo-eta-reduction',
 857           '-fdo-lambda-eta-expansion',
 858           '-freuse-con',
 859           ($Oopt_FoldrBuildInline),
 860                         # you need to inline foldr and build
 861           ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
 862                         # but do reductions if you see them!
 863           $Oopt_PedanticBottoms,
 864           $Oopt_MonadEtaExpansion,
 865           $Oopt_MaxSimplifierIterations,
 866           $Oopt_ShowSimplifierProgress,
 867           ']',
 868
 869         '-fstrictness',
 870
 871         '-fsimplify',
 872           '[',
 873           $Oopt_FB_Support,
 874           '-ffloat-lets-exposing-whnf',
 875           '-ffloat-primops-ok',
 876           '-fcase-of-case',
 877           '-fdo-case-elim',
 878           '-fcase-merge',
 879 #         '-fdo-eta-reduction',
 880           '-fdo-lambda-eta-expansion',
 881           '-freuse-con',
 882           '-flet-to-case',              # Aha! Only done after strictness analysis
 883           $Oopt_PedanticBottoms,
 884           $Oopt_MonadEtaExpansion,
 885           $Oopt_MaxSimplifierIterations,
 886           $Oopt_ShowSimplifierProgress,
 887           ']',
 888
 889         '-ffloat-inwards',
 890
 891 # Case-liberation for -O2.  This should be after
 892 # strictness analysis and the simplification which follows it.
 893
 894 #       ( ($OptLevel != 2)
 895 #        ? ''
 896 #       : "-fliberate-case -fsimplify [ $Oopt_FB_Support -ffloat-lets-exposing-whnf -ffloat-primops-ok -fcase-of-case -fdo-case-elim -fcase-merge -fdo-eta-reduction -fdo-lambda-eta-expansion -freuse-con -flet-to-case $Oopt_PedanticBottoms $Oopt_MonadEtaExpansion $Oopt_MaxSimplifierIterations $Oopt_ShowSimplifierProgress ]" ),
 897
 898 # Final clean-up simplification:
 899
 900         '-fsimplify',
 901           '[',
 902           $Oopt_FB_Support,
 903           '-ffloat-lets-exposing-whnf',
 904           '-ffloat-primops-ok',
 905           '-fcase-of-case',
 906           '-fdo-case-elim',
 907           '-fcase-merge',
 908 #         '-fdo-eta-reduction',
 909           '-fdo-lambda-eta-expansion',
 910           '-freuse-con',
 911           '-flet-to-case',
 912           '-fignore-inline-pragma',     # **** NB!
 913           $Oopt_FoldrBuildInline,
 914           ($Oopt_FoldrBuild) ? ('-fdo-foldr-build') : (),
 915                         # but still do reductions if you see them!
 916           $Oopt_PedanticBottoms,
 917           $Oopt_MonadEtaExpansion,
 918           $Oopt_MaxSimplifierIterations,
 919           $Oopt_ShowSimplifierProgress,
 920           ']',
 921
 922       # '-fstatic-args',
 923
 924 #LATER: '-fcalc-inlinings2', -- pointless for 2.01
 925
 926       # stg2stg passes
 927         '-flambda-lift',
 928         $Oopt_FinalStgProfilingMassage,
 929         $Oopt_StgStats,
 930
 931       # flags for stg2stg
 932         '-flet-no-escape',
 933
 934       # SPECIAL FLAGS for -O2
 935         ($OptLevel == 2) ? (
 936           '-fupdate-analysis',  # virtually useless; relegated to -O2
 937           '-fsemi-tagging',
 938         ) : (),
 939       );
 940
 941 \end{code}
 942
 943 Sort out what we're going to do about optimising.  First, the @hsc@
 944 flags and regular @cc@ flags to worry about:
 945 \begin{code}
 946 if ( $OptLevel <= 0 ) {
 947
 948     # for this level, we tell the parser -fignore-interface-pragmas
 949     push(@HsC_flags, '-fignore-interface-pragmas');
 950     # and tell the compiler not to produce them
 951     push(@HsC_flags, '-fomit-interface-pragmas');
 952
 953     &add_Hsc_flags( @HsC_minusNoO_flags );
 954     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # not optional!
 955
 956 } elsif ( $OptLevel == 1 || $OptLevel == 2 ) {
 957
 958     &add_Hsc_flags( @HsC_minusO_flags );
 959     push(@CcBoth_flags, ($MinusO2ForC || $OptLevel == 2) ? '-O2' : '-O'); # not optional!
 960     # -O? to GCC is not optional! -O2 probably isn't worth it generally,
 961     # but it *is* useful in compiling the garbage collector.
 962
 963 } else { # -Ofile, then...
 964
 965     &add_Hsc_flags( @HsC_minusO3_flags );
 966     push(@HsC_flags, $Oopt_FinalStgProfilingMassage) if $Oopt_FinalStgProfilingMassage;
 967
 968     push(@CcBoth_flags, ($MinusO2ForC) ? '-O2' : '-O'); # possibly to be elaborated...
 969 }
 970
 971 } # setupOptimiseFlags
 972
 973 \end{code}
 974
 975 %************************************************************************
 976 %*                                                                      *
 977 \subsection{Check for consistency, etc.}
 978 %*                                                                      *
 979 %************************************************************************
 980
 981 Sort out @$BuildTag@, @$PROFing@, @$PARing@,
 982 @$GRANing@, @$TICKYing@:
 983 \begin{code}
 984 sub setupBuildFlags {
 985
 986
 987    # PROFILING stuff after argv mangling:
 988    if ( ! $PROFing ) {
 989      # warn about any scc exprs found (in case scc used as identifier)
 990      push(@HsP_flags, '-W');
 991
 992      # add -auto sccs even if not profiling !
 993      push(@HsC_flags, $UNPROFscc_auto) if $UNPROFscc_auto;
 994
 995    } else {
 996       push(@HsC_flags, $PROFauto) if $PROFauto;
 997       push(@HsC_flags, $PROFcaf)  if $PROFcaf;
 998       #push(@HsC_flags, $PROFdict) if $PROFdict;
 999
1000       $Oopt_FinalStgProfilingMassage = '-fmassage-stg-for-profiling';
1001
1002       # Ignore user sccs when auto annotating, but warn when doing so.
1003       $PROFignore_scc = '-W' if $PROFauto;
1004
1005       push(@HsP_flags, (($PROFignore_scc) ? $PROFignore_scc : '-S'));
1006   }
1007   #if ( $BuildTag ne '' ) {
1008   #    local($b) = $BuildDescr{$BuildTag};
1009   #    if ($PARing    eq 'p') { print STDERR "$Pgm: Can't mix $b with -parallel.\n"; exit 1; }
1010   #    if ($GRANing   eq 'g') { print STDERR "$Pgm: Can't mix $b with -gransim.\n"; exit 1; }
1011   #    if ($TICKYing  eq 't') { print STDERR "$Pgm: Can't mix $b with -ticky.\n"; exit 1; }
1012
1013   #    # ok to have a user-way profiling build
1014   #    # eval the profiling opts ... but leave user-way BuildTag
1015   #    if ($PROFing   eq 'p') { &processArgs(split(' ', $SetupOpts{'_p'})); } # eval($EvaldSetupOpts{'_p'}); }
1016
1017   if ( $PROFing eq 'p' ) {
1018       if ($PARing   eq 'p') { print STDERR "$Pgm: Can't do profiling with -parallel.\n"; exit 1; }
1019       if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't do profiling with -gransim.\n"; exit 1; }
1020       if ($TICKYing eq 't') { print STDERR "$Pgm: Can't do profiling with -ticky.\n"; exit 1; }
1021       $BuildTag = '_p' ;
1022
1023   } elsif ( $PARing eq 'p' ) {
1024       if ($GRANing  eq 'g') { print STDERR "$Pgm: Can't mix -parallel with -gransim.\n"; exit 1; }
1025       if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -parallel with -ticky.\n"; exit 1; }
1026       $BuildTag = '_mp';
1027
1028       if ( $Do_lnkr && ( ! $ENV{'PVM_ROOT'} || ! $ENV{'PVM_ARCH'} )) {
1029           print STDERR "$Pgm: both your PVM_ROOT and PVM_ARCH environment variables must be set for linking under -parallel.\n";
1030           exit(1);
1031       }
1032
1033   } elsif ( $GRANing eq 'g' ) {
1034       if ($TICKYing eq 't') { print STDERR "$Pgm: Can't mix -gransim with -ticky.\n"; exit 1; }
1035       $BuildTag = '_mg';
1036
1037   } elsif ( $TICKYing eq 't' ) {
1038       $BuildTag = '_t';
1039   }
1040
1041 \end{code}
1042
1043 After the sanity checks, add flags to the necessary parts of the driver pipeline:
1044
1045 \begin{code}
1046   if ( $BuildTag ne '' ) { # something other than normal sequential...
1047
1048       local($Tag) = "${BuildTag}";
1049       $Tag =~ s/_//;  # move the underscore to the back
1050
1051       $HscOut = '-C='; # must go via C
1052       &processArgs(split(' ', $SetupOpts{$BuildTag}));
1053 #      eval($EvaldSetupOpts{$BuildTag});
1054   }
1055 \end{code}
1056
1057 Decide what the consistency-checking options are in force for this run:
1058 \begin{code}
1059
1060   $HsC_consist_options = "${BuildTag},${DEBUGging}";
1061   $Cc_consist_options  = "${BuildTag},${DEBUGging}";
1062
1063   #
1064   # Funny place to put it, but why not.
1065   #
1066   if ( $HiSuffix_prelude eq '' ) {
1067        local($Tag) = "${BuildTag}";
1068        $Tag =~ s/_//;
1069        $Tag = "${Tag}_" if $Tag ne '';
1070        $HiSuffix_prelude="${Tag}hi";
1071   }
1072 } # setupBuildFlags
1073 \end{code}
1074
1075 %************************************************************************
1076 %*                                                                      *
1077 \subsection{Add on machine-specific C-compiler flags}
1078 %*                                                                      *
1079 %************************************************************************
1080
1081 Shove on magical machine-specific options.  We use \tr{unshift} to
1082 stick them on the {\em front} of the arrays, so that ``later''
1083 user-specified flags can clobber them (e.g., \tr{-U__STG_REV_TBLS__}).
1084
1085 Note: a few ``always apply'' flags were set at the very beginning.
1086
1087 \begin{code}
1088 sub setupMachOpts {
1089
1090   if ($TargetPlatform =~ /^alpha-/) {
1091       unshift(@CcBoth_flags,  ('-static'));
1092
1093   } elsif ($TargetPlatform =~ /^hppa/) {
1094       unshift(@CcBoth_flags,  ('-static'));
1095       #
1096       # We don't put in '-mlong-calls', because it's only
1097       # needed for very big modules (sigh), and we don't want
1098       # to hobble ourselves further on all the other modules
1099       # (most of them).
1100       #
1101       # [Dated comment (gcc-2.6.x?), -mlong-calls is no longer
1102       #  a supported gcc HPPA flag]
1103       unshift(@CcBoth_flags,  ('-D_HPUX_SOURCE'));
1104         # ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
1105         # (very nice, but too bad the HP /usr/include files don't agree.)
1106
1107   } elsif ($TargetPlatform =~ /^i386-/) {
1108       # -fno-defer-pop : basically the same game as for m68k
1109       #
1110       # -fomit-frame-pointer : *must* in .hc files; because we're stealing
1111       #  the fp (%ebp) for our register maps.
1112
1113       unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1114       unshift(@CcRegd_flags_hc, '-fomit-frame-pointer');
1115       unshift(@CcRegd_flags,    "-DSTOLEN_X86_REGS=$StolenX86Regs");
1116
1117   } elsif ($TargetPlatform =~ /^m68k-/) {
1118       # -fno-defer-pop : for the .hc files, we want all the pushing/
1119       #    popping of args to routines to be explicit; if we let things
1120       #    be deferred 'til after an STGJUMP, imminent death is certain!
1121       #
1122       # -fomit-frame-pointer : *don't*
1123       #    It's better to have a6 completely tied up being a frame pointer
1124       #    rather than let GCC pick random things to do with it.
1125       #    (If we want to steal a6, then we would try to do things
1126       #    as on iX86, where we *do* steal the frame pointer [%ebp].)
1127
1128       unshift(@CcRegd_flags_hc, '-fno-defer-pop');
1129       unshift(@CcRegd_flags,    '-fno-omit-frame-pointer');
1130         # maybe gives reg alloc a better time
1131         # also: -fno-defer-pop is not sufficiently well-behaved without it
1132
1133   } elsif ($TargetPlatform =~ /^mips-/) {
1134       unshift(@CcBoth_flags,  ('-static'));
1135
1136   } elsif ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1137       unshift(@CcBoth_flags,  ('-static')); # always easier to start with
1138       unshift(@CcRegd_flags, ('-finhibit-size-directive')); # avoids traceback tables
1139   } elsif ($TargetPlatform =~ /^sparc-/) {
1140   }
1141 } # end of setupMachOpts
1142 \end{code}
1143
1144 %************************************************************************
1145 %*                                                                      *
1146 \subsection{Set up for warnings}
1147 %*                                                                      *
1148 %************************************************************************
1149
1150 Several warnings are turned on by default.  These are supposed to be
1151 the 'I'm pretty sure you've made a mistake here' kind of warnings.
1152 The rest are turned on by the -W and -Wall options, or individually
1153 via their -fwarn and -fno-warn flags.
1154
1155 \begin{code}
1156 sub setupWarningFlags {
1157 &add_Hsc_flags( @StandardWarnings );
1158 }
1159 \end{code}
1160
1161 Same unshifting magic, but for special linker flags.
1162
1163 The configure script determines whether the object file symbol tables
1164 have a leading underscore, and sets @LeadingUnderscore@ accordingly.
1165 (The driver script `sees' the setting of the @LeadingUnderscore@
1166 by having the Makefile prepend it).
1167
1168 \begin{code}
1169 sub setupLinkOpts {
1170   local($uscore) = ( ${LeadingUnderscore} eq 'YES' ) ? '_' : '';
1171
1172   unshift(@Ld_flags,
1173         (($Ld_main) ? ( '-u', "${uscore}Main_" . $Ld_main . '_closure' ) : ()));
1174
1175   # things that are referenced by the RTS - make sure that we pull 'em in
1176   unshift(@Ld_flags,
1177          ( '-u', "${uscore}PrelBase_Izh_static_info"
1178           ,'-u', "${uscore}PrelBase_Czh_static_info"
1179           ,'-u', "${uscore}PrelBase_Fzh_static_info"
1180           ,'-u', "${uscore}PrelBase_Dzh_static_info"
1181           ,'-u', "${uscore}PrelAddr_Azh_static_info"
1182           ,'-u', "${uscore}PrelAddr_Wzh_static_info"
1183           ,'-u', "${uscore}PrelAddr_I64zh_static_info"
1184           ,'-u', "${uscore}PrelAddr_W64zh_static_info"
1185           ,'-u', "${uscore}PrelStable_StablePtr_static_info"
1186           ,'-u', "${uscore}PrelBase_Izh_con_info"
1187           ,'-u', "${uscore}PrelBase_Czh_con_info"
1188           ,'-u', "${uscore}PrelBase_Fzh_con_info"
1189           ,'-u', "${uscore}PrelBase_Dzh_con_info"
1190           ,'-u', "${uscore}PrelAddr_Azh_con_info"
1191           ,'-u', "${uscore}PrelAddr_Wzh_con_info"
1192           ,'-u', "${uscore}PrelAddr_I64zh_con_info"
1193           ,'-u', "${uscore}PrelAddr_W64zh_con_info"
1194           ,'-u', "${uscore}PrelStable_StablePtr_con_info"
1195           ,'-u', "${uscore}PrelBase_False_static_closure"
1196           ,'-u', "${uscore}PrelBase_True_static_closure"
1197           ,'-u', "${uscore}PrelPack_unpackCString_closure"
1198         ));
1199   if (!$NoHaskellMain) {
1200    unshift (@Ld_flags,'-u', "${uscore}PrelMain_mainIO_closure");
1201   }
1202   if ($TargetPlatform =~ /^powerpc-|^rs6000-/) {
1203     # sometimes we have lots of toc entries...
1204     #  unshift(@Ld_flags, ('-Xlinker -bbigtoc -Xlinker -bnoquiet'));
1205     unshift(@Ld_flags, ('-Xlinker -bbigtoc'));
1206   }
1207
1208 } # end of setupLinkOpts
1209
1210 \end{code}
1211
1212 %************************************************************************
1213 %*                                                                      *
1214 \subsection{Set up include paths and system-library enslurpment}
1215 %*                                                                      *
1216 %************************************************************************
1217
1218 Now that we know what garbage-collector, etc., are required, we can
1219 finalise our list of libraries to slurp through, and generally Get
1220 Ready for Business.
1221
1222 \begin{code}
1223 sub setupIncPaths {
1224   # default includes must be added AFTER option processing
1225   if ( ! $INSTALLING ) {
1226       push (@Include_dir, "$TopPwd/${CURRENT_DIR}/${GHC_INCLUDE_DIR}");
1227   } else {
1228       push (@Include_dir, "$InstLibDirGhc/includes");
1229       push (@Include_dir, "$InstLibDirGhc/includes");
1230   }
1231 } # end of setupIncPaths
1232 \end{code}
1233
1234 \begin{code}
1235 sub setupSyslibs {
1236   push(@SysLibrary, ( '-lHS', '-lHS_cbits' )); # basic I/O and prelude stuff
1237
1238   local($f);
1239   foreach $f (@SysLibrary) {
1240       next if $f =~ /_cbits/;
1241       $f .= $BuildTag if $f =~ /^-lHS/;
1242   }
1243
1244   # Push library HSrts, plus boring clib bit
1245   push(@SysLibrary, "-lHSrts${BuildTag}");
1246
1247   #
1248   # RTS compiled with cygwin32, uses the WinMM API
1249   # to implement the itimers, since cygwin.dll does not
1250   # support it. Only reqd. for `ways' that use itimers.
1251   #
1252   push(@SysLibrary, '-lwinmm') if $TargetPlatform eq 'i386-unknown-cygwin32';
1253
1254   # Push the pvm libraries
1255   if ($BuildTag eq '_mp') {
1256       $pvmlib = "$ENV{'PVM_ROOT'}/lib/$ENV{'PVM_ARCH'}";
1257       push(@SysLibrary, "-L$pvmlib", '-lgpvm3', '-lpvm3');
1258       if ( $ENV{'PVM_ARCH'} eq 'SUNMP' ) {
1259           push(@SysLibrary, '-lthread', '-lsocket', '-lnsl');
1260       } elsif ( $ENV{'PVM_ARCH'} eq 'SUN4SOL2' ) {
1261           push(@SysLibrary, '-lsocket', '-lnsl');
1262       }
1263   }
1264
1265 # Push the GNU multi-precision arith lib; and the math library
1266
1267 # If this machine has GMP already installed, then we'll get the installed
1268 # lib here, because presumably the one in the tree won't have been built.
1269
1270 if ($LibGmp eq 'not-installed') {
1271   push(@SysLibrary, "-lgmp");
1272 } else {
1273   push(@SysLibrary, "-l$LibGmp");
1274 }
1275
1276 push(@SysLibrary, '-lm');
1277 \end{code}
1278
1279 %************************************************************************
1280 %*                                                                      *
1281 \subsection{Check that this system was built to do what we are asking}
1282 %*                                                                      *
1283 %************************************************************************
1284
1285 Before continuing we check that the appropriate build is available.
1286
1287 \begin{code}
1288 #die "$Pgm: no BuildAvail?? $BuildTag\n" if $BuildDescr{$BuildTag} eq '' ; # sanity
1289
1290 if ( $BuildDescr{$BuildTag} eq '' ) {
1291     print STDERR "$Pgm: a `", $BuildDescr{$BuildTag},
1292         "' \"build\" is not available with your GHC setup.\n";
1293     print STDERR "(It was not configured for it at your site.)\n";
1294     print STDERR $ShortUsage;
1295     exit 1;
1296 }
1297
1298 } # end of setupSyslibs
1299
1300 \end{code}
1301
1302 %************************************************************************
1303 %*                                                                      *
1304 \subsection{Final miscellaneous setup bits before we start going}
1305 %*                                                                      *
1306 %************************************************************************
1307
1308 Record largest specific heapsize, if any.
1309 \begin{code}
1310 sub setupHeapStackSize {
1311    $Specific_heap_size = $Specific_heap_size * $Scale_sizes_by;
1312    push(@HsC_rts_flags, '-H'.$Specific_heap_size);
1313    $Specific_stk_size = $Specific_stk_size * $Scale_sizes_by;
1314    push(@HsC_rts_flags, "-K$Specific_stk_size");
1315 }
1316 \end{code}
1317
1318 If no input or link files seen, then we let 'em feed in stdin; this is
1319 mainly for debugging.
1320
1321 \begin{code}
1322
1323 if ($#Input_file < 0 && $#Link_file < 0) {
1324     @Input_file = ( '-' );
1325
1326     open(INF, "> $Tmp_prefix.hs") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.hs\n");
1327     print STDERR "Enter your Haskell program, end with ^D (on a line of its own):\n" if -t;
1328     while (<STDIN>) { print INF $_; }
1329     close(INF) || &tidy_up_and_die(1,"Failed writing to $Tmp_prefix.hs\n");
1330 }
1331
1332 \end{code}
1333
1334 Tell the world who we are, if they asked.
1335 \begin{code}
1336 print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"
1337     if $Verbose;
1338 \end{code}
1339
1340 %************************************************************************
1341 %*                                                                      *
1342 \section[Driver-main-loop]{Main loop: Process input files, and link if required}
1343 %*                                                                      *
1344 %************************************************************************
1345
1346 Process the input files; don't continue with linking if there are
1347 problems (global variable @$Status@ non-zero).
1348 \begin{code}
1349 foreach $ifile (@Input_file) {
1350     &ProcessInputFile($ifile);
1351 }
1352
1353 if ( $Status > 0 ) { # don't link if there were errors...
1354     print STDERR $ShortUsage;
1355     &tidy_up();
1356     exit $Status;
1357 }
1358
1359 # append last minute flags linker and consistency flags
1360 &setupBuildFlags();
1361 &setupSyslibs();
1362 &setupLinkOpts();
1363
1364 \end{code}
1365
1366 Link if appropriate.
1367 \begin{code}
1368 if ($Do_lnkr) {
1369     local($libdirs) = '';
1370
1371     # glue them together:
1372     push(@UserLibrary_dir, @SysLibrary_dir);
1373
1374     $libdirs = '-L' . join(' -L',@UserLibrary_dir) if $#UserLibrary_dir >= 0;
1375
1376     # for a linker, use an explicitly given one, or the going C compiler ...
1377     local($lnkr) = ( $Lnkr ) ? $Lnkr : $CcRegd;
1378
1379     if ( ($Specific_output_file eq '') &&
1380          ($TargetPlatform eq 'i386-unknown-cygwin32') ) {
1381          $Specific_output_file = 'main.exe';
1382          print STDERR "Output file not specified, defaulting to \"main.exe\"\n";
1383     }
1384
1385     local($output) = ($Specific_output_file ne '') ? "-o $Specific_output_file" : '';
1386     @Files_to_tidy = ($Specific_output_file ne '') ? $Specific_output_file : 'a.out';
1387
1388     local($to_do) = "$lnkr $Verbose @Ld_flags $output @Link_file $TopClosureFile $libdirs @UserLibrary @SysLibrary";
1389     &run_something($to_do, 'Linker');
1390
1391     # finally, check the consistency info in the binary
1392     local($executable) = $Files_to_tidy[0];
1393     @Files_to_tidy = (); # reset; we don't want to nuke it if it's inconsistent
1394
1395     if ( $LinkChk ) {
1396         # dynamically load consistency-chking code; then do it.
1397         require('ghc-consist.prl')
1398             || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-consist.prl!\n");
1399
1400         &chk_consistency_info ( $executable );
1401     }
1402
1403     # if PVM parallel stuff, we do truly weird things.
1404     # Essentially: (1) move the executable over to where PVM expects
1405     # to find it.  (2) create a script in place of the executable
1406     # which will cause the program to be run, via SysMan.
1407     if ( $PARing eq 'p' ) {
1408         local($pvm_executable) = $executable;
1409         local($pvm_executable_base);
1410
1411         if ( $pvm_executable !~ /^\// ) { # a relative path name: make absolute
1412             local($pwd) = `pwd`;
1413             chop($pwd);
1414             $pwd =~ s/^\/tmp_mnt//;
1415             $pvm_executable = "$pwd/$pvm_executable";
1416         }
1417
1418         $pvm_executable =~ s|/|=|g; # make /s into =s
1419         $pvm_executable_base = $pvm_executable;
1420
1421         $pvm_executable = $ENV{'PVM_ROOT'} . '/bin/' . $ENV{'PVM_ARCH'}
1422                         . "/$pvm_executable";
1423
1424         &run_something("$Rm -f $pvm_executable; $Cp -p $executable $pvm_executable && $Rm -f $executable", 'Moving binary to PVM land');
1425
1426         # OK, now create the magic script for "$executable"
1427         open(EXEC, "> $executable") || &tidy_up_and_die(1,"$Pgm: couldn't open $executable to write!\n");
1428         print EXEC <<EOSCRIPT1;
1429 eval 'exec perl -S \$0 \${1+"\$@"}'
1430   if \$running_under_some_shell;
1431 # =!=!=!=!=!=!=!=!=!=!=!
1432 # This script is automatically generated: DO NOT EDIT!!!
1433 # Generated by Glasgow Haskell, version ${ProjectVersion} ${ProjectPatchLevel}
1434 #
1435 \$pvm_executable      = '$pvm_executable';
1436 \$pvm_executable_base = '$pvm_executable_base';
1437 \$SysMan = '$SysMan';
1438 EOSCRIPT1
1439
1440         print EXEC <<\EOSCRIPT2;
1441 # first, some magical shortcuts to run "commands" on the binary
1442 # (which is hidden)
1443 if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {
1444     local($cmd) = $1;
1445     system("$cmd $pvm_executable");
1446     exit(0); # all done
1447 }
1448
1449 # OK, really run it; process the args first
1450 $ENV{'PE'} = $pvm_executable_base;
1451 $debug = '';
1452 $nprocessors = 2; # the default
1453 @nonPVM_args = ();
1454 $in_RTS_args = 0;
1455
1456 # ToDo: handle --RTS
1457 args: while ($a = shift(@ARGV)) {
1458     if ( $a eq '+RTS' ) {
1459         $in_RTS_args = 1;
1460     } elsif ( $a eq '-RTS' ) {
1461         $in_RTS_args = 0;
1462     }
1463     if ( $a eq '-d' && $in_RTS_args ) {
1464         $debug = '-';
1465     } elsif ( $a =~ /^-N(\d+)/ && $in_RTS_args ) {
1466         $nprocessors = $1;
1467     } else {
1468         push(@nonPVM_args, $a);
1469     }
1470 }
1471
1472 local($return_val) = 0;
1473 system("$SysMan $debug $pvm_executable $nprocessors @nonPVM_args");
1474 $return_val = $?;
1475 system("mv $ENV{'HOME'}/$pvm_executable_base.???.gr .") if -f "$ENV{'HOME'}/$pvm_executable_base.001.gr";
1476 exit($return_val);
1477 EOSCRIPT2
1478         close(EXEC) || die "Failed closing $executable\n";
1479         chmod 0755, $executable;
1480     }
1481 }
1482
1483 # that...  that's all, folks!
1484 &tidy_up();
1485 exit $Status; # will still be 0 if all went well
1486 \end{code}
1487
1488 %************************************************************************
1489 %*                                                                      *
1490 \section[Driver-do-one-file]{How to process a single input file}
1491 %*                                                                      *
1492 %************************************************************************
1493
1494 \begin{code}
1495 sub ProcessInputFile {
1496     local($ifile) = @_;   # input file name
1497     local($ifile_root);   # root of or basename of input file
1498     local($ofile_target); # ultimate output file we hope to produce
1499                           # from input file (need to know for recomp
1500                           # checking purposes)
1501     local($hifile_target);# ditto (but .hi file)
1502     local($ofile_c_stub_target);
1503     local($ofile_h_stub_target);
1504 \end{code}
1505
1506 Handle the weirdity of input from stdin.
1507 \begin{code}
1508     if ($ifile ne '-') {
1509         ($ifile_root  = $ifile) =~ s/\.[^\.\/]+$//;
1510         $ofile_target = # may be reset later...
1511                         ($Specific_output_file ne '' && ! $Do_lnkr)
1512                         ? $Specific_output_file
1513                         : &odir_ify($ifile_root, 'o');
1514         $hifile_target= ($Specific_hi_file ne '')
1515                         ? $Specific_hi_file
1516                         : "$ifile_root.$HiSuffix"; # ToDo: odirify?
1517                         # NB: may change if $ifile_root isn't module name (??)
1518         ($ofile_c_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.c/;
1519         ($ofile_h_stub_target = $ifile) =~s/\.[^\.\/]+$/_stub.h/;
1520     } else {
1521         $ifile = "$Tmp_prefix.hs"; # we know that's where we put the input
1522         $ifile_root   = '_stdin';
1523         $ofile_target = '_stdout'; # gratuitous?
1524         $hifile_target= '_stdout'; # ditto?
1525     }
1526 \end{code}
1527
1528 We need to decide what phases of the compilation system we will run
1529 over this file.  The defaults are the ones established when processing
1530 flags.  (That established what the last phase run for all files is.)
1531
1532 We do the pre-recompilation-checker phases here; the rest later.
1533 \begin{code}
1534 \end{code}
1535
1536 Look at the suffix and decide what initial phases of compilation may
1537 be dropped off for this file.  Also the rather boring business of
1538 which files are coming-in/going-out.
1539
1540 Again, we'll do the post-recompilation-checker parts of this later.
1541 \begin{code}
1542     local($do_lit2pgm)  = ($ifile =~ /\.lhs$/) ? 1 : 0;
1543     local($do_hscpp)    = 1; # but "hscpp" might really be "cat"
1544     local($do_hsc)      = 1;
1545
1546     # names of the files to stuff between phases
1547     # defaults are temporaries
1548     local($in_lit2pgm)    = $ifile;
1549     local($lit2pgm_hscpp) = "$Tmp_prefix.lpp";
1550     local($hscpp_hsc)     = "$Tmp_prefix.cpp";
1551     local($hsc_hi)        = "$Tmp_prefix.hi";
1552     local($cc_as_o)       = "${Tmp_prefix}_o.s"; # temporary for raw .s file if opt C
1553     local($cc_as)         = "$Tmp_prefix.s";     # mangled or hsc-produced .s code
1554     local($as_out)        = $ofile_target;
1555
1556     local($is_hc_file) = 1; #Is the C code .hc or .c? Assume .hc for now
1557
1558     # OK, let's strip off some literate junk..
1559     if ($do_lit2pgm) {
1560         &runLit2pgm($in_lit2pgm, $lit2pgm_hscpp)
1561     } else {
1562         $lit2pgm_hscpp = $ifile;
1563     }
1564
1565     #
1566     @File_options = ();
1567
1568     # Scan the top of the de-litted file for {-# OPTIONS #-} pragmas
1569     &check_for_source_options($lit2pgm_hscpp,$ifile);
1570
1571     # Options found in the source file take a back seat, i.e., we scan
1572     # them first. Only process the command line again if source file
1573     # contained anything of interest *or* there's more than one
1574     # input file (we have to reset the options).
1575     #
1576     if ( $#Input_file >= 0 || $#File_options >= 0) {
1577         #@File_options = (@File_options, @Cmd_opts);
1578
1579         # Now process the command line
1580         &initDriverGlobals();
1581         &processArgs((@File_options,@Cmd_opts));
1582         print STDERR "\nEffective command line: " .
1583                      join(' ',(@File_options,@Cmd_opts)) . "\n" if $Verbose;
1584     }
1585     #
1586     # Having got the effective command line scanned, set up
1587     # the various options in prep for some real work.
1588     #
1589     # check the sanity of the BuildTag we're about to use,
1590     # and if needs be, add some more flags and setup to
1591     # the different phases.
1592     #
1593     &setupBuildFlags();
1594     &setupOptimiseFlags();
1595     &setupMachOpts();
1596     &setupIncPaths();
1597     &setupWarningFlags();
1598     &setupHeapStackSize();
1599
1600     #
1601     # These two variables need to be set after the
1602     # command-line has been processed and the build options
1603     # have be seen set up. This is because command-line options
1604     # can control whether to compile vias C or not.
1605     #
1606     local($do_cc)       = ( $Do_cc != -1) # i.e., it was set explicitly
1607                           ? $Do_cc
1608                           : ( ($HscOut eq '-C=') ? 1 : 0 );
1609     local($do_as)       = $Do_as;
1610     local($hsc_out)        = ( $HscOut eq '-C=' ) ? "$Tmp_prefix.hc" : "$Tmp_prefix.s" ;
1611     local($hsc_out_c_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.c" : "";
1612     local($hsc_out_h_stub) = ( $HscOut eq '-C=' ) ? "${Tmp_prefix}_stb.h" : "";
1613
1614     if ($Only_preprocess_hc) { # stop after having run $Cc -E
1615        $do_as=0;
1616     }
1617     if ($Only_preprocess_C)     { # stop after having run $hscpp
1618        $do_hsc=0; $do_cc = 0; $do_as=0;
1619     } elsif ($ifile =~ /.lhs$/ || $ifile =~ /.hs$/ ) {
1620        ;
1621     } elsif ($ifile =~ /\.hc$/ || $ifile =~ /_hc$/ ) { # || $ifile =~ /\.$Isuffix$/o) # ToDo: better
1622         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1623         $hsc_out = $ifile;
1624         $hsc_out_c_stub = '';
1625         $hsc_out_h_stub = '';
1626     } elsif ($ifile =~ /\.c$/) {
1627         $do_hscpp = 0; $do_hsc = 0; $do_cc = 1;
1628         $hsc_out = $ifile; $is_hc_file = 0;
1629         $hsc_out_c_stub = '';
1630         $hsc_out_h_stub = '';
1631     } elsif ($ifile =~ /\.[sS]$/) {
1632         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0;
1633         $cc_as = $ifile;
1634     } else { # don't know what it is, but nothing to do herein...
1635         $do_hscpp = 0; $do_hsc = 0; $do_cc = 0; $do_as = 0;
1636     }
1637
1638     # hack to avoid running hscpp
1639     $HsCpp = $Cat if ! $Cpp_flag_set;
1640
1641     &runHscpp($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) if $do_hscpp;
1642
1643 \end{code}
1644
1645 We now think about whether to run hsc/cc or not (when hsc produces .s
1646 stuff, it effectively takes the place of both phases).
1647 To get the output file name right: for each phase that we are {\em
1648 not} going to run, set its input (i.e., the output of its preceding
1649 phase) to @"$ifile_root.<suffix>"@.
1650
1651 \begin{code}
1652     local($going_interactive) = $HscOut eq '-N=' || $ifile_root eq '_stdin';
1653
1654     #
1655     # Warning issued if -keep-hc-file-too is used without
1656     # -fvia-C (or the equivalent)
1657     #
1658     if ( $HscOut ne '-C=' && $Keep_hc_file_too ) {
1659         print STDERR "$Pgm: warning: Native code generator to be used, -keep-hc-file-too will be ignored\n";
1660     }
1661
1662     if (! $do_cc && ! $do_as) { # stopping after hsc
1663         $hsc_out = ($Specific_output_file ne '')
1664                  ? $Specific_output_file
1665                  : &odir_ify($ifile_root, ($HscOut eq '-C=') ? 'hc' : 's');
1666
1667         $ofile_target = $hsc_out; # reset
1668     }
1669
1670     if (! $do_as) { # stopping after gcc (or hsc)
1671         $cc_as = ($Specific_output_file ne '')
1672                  ? $Specific_output_file
1673                  : &odir_ify($ifile_root, ( $Only_preprocess_hc ) ? 'i' : 's');
1674
1675         $ofile_target = $cc_as; # reset
1676     }
1677
1678 \end{code}
1679
1680
1681 Now the Haskell compiler, C compiler, and assembler
1682
1683 \begin{code}
1684    if ($do_hsc) {
1685         &runHscAndProcessInterfaces( $ifile, $hscpp_hsc, $ifile_root,
1686                                      $ofile_target, $hifile_target,
1687                                      $going_interactive);
1688     }
1689
1690     if (-f $hsc_out_h_stub) {
1691         &run_something("cp $hsc_out_h_stub $ofile_h_stub_target", 'Copy foreign export header file');
1692     }
1693
1694     if (-f $hsc_out_c_stub) {
1695         &run_something("cp $hsc_out_c_stub $ofile_c_stub_target", 'Copy foreign export C stubs');
1696         local ($hsc_out_s_stub);
1697         local ($hsc_out_o_stub);
1698         ($ofile_s_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.s/;
1699         ($ofile_o_stub_target = $ofile_c_stub_target) =~ s/\.(.*)$/\.o/;
1700         &runGcc    (0, $ofile_c_stub_target, $ofile_s_stub_target);
1701         &runAs     ($ofile_o_stub_target, $ofile_s_stub_target);
1702         #
1703         # Bring the C stub protos into scope when compiling the .hc file.
1704         #
1705         push (@CcInjects, "#include \"${hsc_out_h_stub}\"\n");
1706         # Hack - ensure that the stub .h file is included in the OPTIONS section
1707         #        if the .hc file is saved.
1708         push (@File_options, "-#include \"${ofile_h_stub_target}\"\n");
1709
1710     }
1711
1712     if ($do_cc) {
1713         &runGcc    ($is_hc_file, $hsc_out, $cc_as_o);
1714         &runMangler($is_hc_file, $cc_as_o, $cc_as, $ifile_root) if ! $Only_preprocess_hc;
1715     }
1716
1717     &split_asm_file($cc_as)  if $do_as && $SplitObjFiles;
1718
1719     # save a copy of the .s file..
1720     &saveIntermediate($ifile_root , "s" , $cc_as) if ($do_as && $Keep_s_file_too);
1721     &runAs($as_out, $ifile_root) if $do_as;
1722 \end{code}
1723
1724 Finally, decide what to queue up for linker input.
1725 \begin{code}
1726     # tentatively assume we will eventually produce linker input:
1727     push(@Link_file, &odir_ify($ifile_root, 'o'));
1728
1729 #ToDo:    local($or_isuf) = ($Isuffix eq '') ? '' : "|$Isuffix";
1730
1731     if ( $ifile !~ /\.(lhs|hs|hc|c|s|a|S)$/ && $ifile !~ /_hc$/ ) {
1732         # There's sometimes confusion regarding .hi files; users
1733         # supplying them on the command line.
1734         if ( $ifile =~ /\.hi$/ ) {
1735             print STDERR "$Pgm: warning: found `$ifile' on command line; interface files should not be supplied here - ignoring it.\n";
1736         } else {
1737            print STDERR "$Pgm: don't recognise suffix on `$ifile'; passing it through to linker\n";
1738         }
1739         # oops; we tentatively pushed the wrong thing; fix & do the right thing
1740         pop(@Link_file); push(@Link_file, $ifile);
1741     }
1742
1743
1744 } # end of ProcessInputFile
1745 \end{code}
1746
1747 %************************************************************************
1748 %*                                                                      *
1749 \section[Driver-run-phases]{Routines to run the various phases}
1750 %*                                                                      *
1751 %************************************************************************
1752
1753 \begin{code}
1754 sub runLit2pgm {
1755     local($in_lit2pgm, $lit2pgm_hscpp) = @_;
1756
1757     local($to_do) = "";
1758
1759     # Only add #line pragma if we're going to need it.
1760     $to_do  = "echo '#line 1 \"$in_lit2pgm\"' > $lit2pgm_hscpp && " if ($Cpp_flag_set);
1761     $to_do .= "$Unlit @Unlit_flags $in_lit2pgm -  >> $lit2pgm_hscpp";
1762
1763     push(@Files_to_tidy, $lit2pgm_hscpp );
1764
1765     &run_something($to_do, 'literate pre-processor');
1766 }
1767 \end{code}
1768
1769 \begin{code}
1770 sub runHscpp {
1771     local($in_lit2pgm, $lit2pgm_hscpp, $hscpp_hsc) = @_;
1772
1773     local($to_do) = "";
1774
1775     # Strictly speaking, echoing of the following line pragma is only required
1776     # on non-delit'ed input, as we've already added it during de-lit. However,
1777     # hscpp will then add a {-# LINE 1 "$lit2pgm_hsc" -} to the top of the file,
1778     # which is not very informative (but harmless). Hence, we uniformly have
1779     # {-# LINE 1 "$in_lit2pgm" #-} as the first line to all cpp'ed hsc input.
1780     #
1781     $to_do = "echo '{-# LINE 1 \"$in_lit2pgm\" -}' > $hscpp_hsc && ";
1782
1783     if ($HsCpp eq $Cat) {
1784         $to_do .= "$HsCpp $lit2pgm_hscpp >> $hscpp_hsc";
1785         push(@Files_to_tidy, $hscpp_hsc );
1786         &run_something($to_do, 'Ineffective C pre-processor');
1787     } else {
1788         local($includes) = '-I' . join(' -I',@Include_dir);
1789         $to_do .= "$HsCpp $Verbose @HsCpp_flags @HsSourceCppOpts $includes $lit2pgm_hscpp >> $hscpp_hsc";
1790         push(@Files_to_tidy, $hscpp_hsc );
1791         &run_something($to_do, 'Haskellised C pre-processor');
1792     }
1793
1794     if ( $Only_preprocess_C ) {
1795         $to_do = "$Cat $hscpp_hsc";
1796         &run_something($to_do, '');
1797     }
1798
1799 }
1800 \end{code}
1801
1802
1803 \begin{code}
1804 sub runHscAndProcessInterfaces {
1805     local($ifile, $hscpp_hsc, $ifile_root,
1806           $ofile_target, $hifile_target,
1807           $going_interactive) = @_;
1808
1809         # $ifile                is the original input file
1810         # $hscpp_hsc            post-unlit, post-cpp, etc., input file
1811         # $ifile_root           input filename minus suffix
1812         # $ofile_target         the output file that we ultimately hope to produce
1813         # $hifile_target        the .hi file ... (ditto)
1814
1815     local($source_unchanged) = 1;
1816
1817     # Check if the source file is up to date relative to the target; in
1818     # that case we say "source is unchanged" and let the compiler bail out
1819     # early if the import usage information allows it.
1820
1821     ($i_dev,$i_ino,$i_mode,$i_nlink,$i_uid,$i_gid,$i_rdev,$i_size,
1822      $i_atime,$i_mtime,$i_ctime,$i_blksize,$i_blocks) = stat($ifile);
1823
1824     # The informational messages below are now conditional on -v being set -- SOF
1825     if ( $ofile_target ne "_stdin.s" && ! -f $ofile_target ) {
1826         print STDERR "$Pgm:compile:Output file $ofile_target doesn't exist\n" if $Verbose;
1827         $source_unchanged = 0;
1828     }
1829
1830     ($o_dev,$o_ino,$o_mode,$o_nlink,$o_uid,$o_gid,$o_rdev,$o_size,
1831      $o_atime,$o_mtime,$o_ctime,$o_blksize,$o_blocks) = stat(_); # stat info from -f test
1832
1833     if ( $hifile_target ne "_stdout" && ! -f $hifile_target ) {
1834         print STDERR "$Pgm:compile:Interface file $hifile_target doesn't exist\n" if $Verbose;
1835         $source_unchanged = 0;
1836     }
1837
1838     ($hi_dev,$hi_ino,$hi_mode,$hi_nlink,$hi_uid,$hi_gid,$hi_rdev,$hi_size,
1839      $hi_atime,$hi_mtime,$hi_ctime,$hi_blksize,$hi_blocks) = stat(_); # stat info from -f test
1840
1841     if ( $ofile_target ne "_stdin.s" && $i_mtime > $o_mtime) {
1842         print STDERR "$Pgm:recompile:Input file $ifile newer than $ofile_target\n" if $Verbose;
1843         $source_unchanged = 0;
1844     }
1845
1846     # Tell the compiler which version we're using
1847     push(@HsC_flags, "-fhi-version=${ProjectVersionInt}");
1848
1849     # So if source_unchanged is still "1", we pass on the good news to the compiler
1850     # The -recomp flag can disable this, forcing recompilation
1851     if ($Do_recomp_chkr && $source_unchanged) {
1852         push(@HsC_flags, '-fsource-unchanged');
1853     }
1854
1855     # Run the compiler
1856
1857     &runHsc($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive);
1858
1859    # See if it bailed out early, saying nothing needed doing.
1860    # We work this out by seeing if it created an output .hi file
1861
1862     if ( ! -f $hsc_hi && $ProduceHi !~ /-nohifile=/ ) {
1863         # Doesn't exist, so we bailed out early.
1864         # Tell the C compiler and assembler not to run
1865         $do_cc = 0; $do_as = 0;
1866
1867         # Update dependency info, touch both object file and
1868         # interface file, so that the following invariant is
1869         # maintained:
1870         #
1871         #   a dependent module's interface file should after recompilation
1872         #   checking be newer than the interface files of its imports.
1873         #
1874         # That is, if module A's interface file changes, then module B
1875         # (which import from A) needs to be checked.
1876         # If A's change does not affect B, which causes the compiler to bail
1877         # out early, we still need to touch the interface file of B. The reason
1878         # for this is that B may export A's interface.
1879         #
1880         &run_something("touch $ofile_target",
1881                        "Touch $ofile_target,  to propagate dependencies") if $HscOut ne '-N=';
1882         &run_something("touch $hifile_target",
1883                        "Touch $hifile_target,  to propagate dependencies") if $ProduceHi =~ /-nohifile=/ ;
1884
1885     } else {
1886
1887      # Didn't bail out early (new .hi file) so we thunder on
1888
1889         # If non-interactive, heave in the consistency info at the end
1890         # NB: pretty hackish (depends on how $output is set)
1891         if ( ! $going_interactive ) {
1892             if ( $HscOut eq '-C=' ) {
1893             $to_do = "echo 'static char ghc_hsc_ID[] = \"\@(#)hsc $ifile\t$HsC_major_version.$HsC_minor_version,$HsC_consist_options\";' >> $hsc_out";
1894
1895             } elsif ( $HscOut eq '-S=' ) {
1896                 local($consist) = "hsc.$ifile.$HsC_major_version.$HsC_minor_version.$HsC_consist_options";
1897                 $consist =~ s/,/./g;
1898                 $consist =~ s/\//./g;
1899                 $consist =~ s/-/_/g;
1900                 $consist =~ s/[^A-Za-z0-9_.]/ZZ/g; # ToDo: properly?
1901                 $to_do = "echo '\n\t.text\n$consist:' >> $hsc_out";
1902             }
1903             &run_something($to_do, 'Pin on Haskell consistency info');
1904         }
1905
1906
1907         # Interface-handling is important enough to live off by itself
1908         if ( $ProduceHi !~ /-nohifile=/ ) { # If we've produced one, process it.
1909            require('ghc-iface.prl') || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-iface.prl!\n");
1910            &postprocessHiFile($hsc_hi, $hifile_target, $going_interactive);
1911         }
1912         # if we're going to split up object files,
1913         # we inject split markers into the .hc file now
1914         if ( $HscOut eq '-C=' && $SplitObjFiles ) {
1915             &inject_split_markers ( $hsc_out );
1916         }
1917
1918         # save a copy of the .hc file, even if we are carrying on...
1919         if ($HscOut eq '-C=' && $do_cc && $Keep_hc_file_too) {
1920             &saveIntermediate($ifile_root , "hc" , $hsc_out);
1921         }
1922
1923     }
1924 }
1925 \end{code}
1926
1927
1928 \begin{code}
1929 sub runHsc {
1930     local($ifile_root, $hsc_out, $hsc_hi, $hsc_out_c_stub, $hsc_out_h_stub, $going_interactive) = @_;
1931
1932     # prepend comma to HsP flags (so hsc can tell them apart...)
1933     foreach $a ( @HsP_flags ) { $a = ",$a" unless $a =~ /^,/; }
1934
1935     &makeHiMap() unless $HiMapDone;
1936     push(@HsC_flags, "-himap=$HiIncludeString");
1937
1938     # here, we may produce .hc/.s and/or .hi files
1939     local($output) = '';
1940     #@Files_to_tidy = ();
1941
1942     if ( $going_interactive ) {
1943         # don't need .hi unless we're going to show it on stdout:
1944         $ProduceHi = '-nohifile=' if ! $HiOnStdout;
1945         $do_cc = 0; $do_as = 0; $Do_lnkr = 0; # and we won't go any further...
1946     }
1947
1948     # set up for producing output/.hi; note that flag twiddling
1949     # may mean that nothing will actually be produced:
1950     $output = "$ProduceHi$hsc_hi $HscOut$hsc_out -F=$hsc_out_c_stub -FH=$hsc_out_h_stub";
1951     push(@Files_to_tidy, $hsc_hi, $hsc_out, $hsc_out_c_stub, $hsc_out_h_stub );
1952
1953     # if we're compiling foo.hs, we want the GC stats to end up in foo.stat
1954     if ( $CollectingGCstats ) {
1955         push(@HsC_rts_flags, "-S$ifile_root.stat");
1956         push(@Files_to_tidy, "$ifile_root.stat");
1957     }
1958
1959     if ( $CollectGhcTimings ) { # assume $RTS_style eq 'ghc'
1960         # emit nofibbish time/bytes-alloc stats to stderr;
1961         # see later .stat file post-processing
1962         print STDERR "warning: both -Rgc-stats and -Rghc-timing used, -Rghc-timing wins." if $CollectingGCstats;
1963         push(@HsC_rts_flags, "-s$Tmp_prefix.stat");
1964         push(@Files_to_tidy, "$Tmp_prefix.stat");
1965     }
1966
1967     local($dump) = '';
1968     if ($Specific_dump_file ne '') {
1969         $dump = "2>> $Specific_dump_file";
1970         $Using_dump_file = 1;
1971     }
1972
1973     local($to_do);
1974     # Win32 only: If the command processor used by system()
1975     # exec()s the application as an ordinary Win32 executable,
1976     # we're in trouble here, since the command line is likely
1977     # to be > 255 chars long. To work around this situation,
1978     # $HsC also understands `at-files',  i.e., `@file' on the
1979     # command line will cause $HsC to add the contents of `file'
1980     # to the command line.
1981     #
1982     #  [ Note: support for `at-files' is not compiled in by default ]
1983     $cmd_line_opts_via_at_file=0;
1984     if ($cmd_line_opts_via_at_file) {
1985
1986       local($to_do_opts) = "$Tmp_prefix.opts";
1987       open(OPTS, "> $Tmp_prefix.opts") || &tidy_up_and_die(1,"Can't open $Tmp_prefix.opts\n");
1988       print OPTS "$dump @HsC_flags $CoreLint $StgLint $Verbose";
1989       close(OPTS);
1990       $to_do = "$HsC @HsP_flags ,$hscpp_hsc \@$Tmp_prefix.opts $output +RTS @HsC_rts_flags";
1991
1992     } else {
1993
1994       $to_do = "$HsC @HsP_flags ,$hscpp_hsc $dump @HsC_flags $CoreLint $StgLint $Verbose $output +RTS @HsC_rts_flags";
1995     }
1996     &run_something($to_do, 'Haskell compiler');
1997
1998     # finish business w/ nofibbish time/bytes-alloc stats
1999     &process_ghc_timings() if $CollectGhcTimings;
2000 }
2001 \end{code}
2002
2003 Use \tr{@Import_dir} and \tr{@SysImport_dir} to make a tmp file
2004 of (module-name, pathname) pairs, one per line, separated by a space.
2005 \begin{code}
2006 $HiMapDone = 0;
2007 $HiIncludeString = ();          # dir1:dir2:dir3, to pass to GHC
2008
2009 sub makeHiMap {
2010
2011     # collect in %HiMap; write later; also used elsewhere in driver
2012
2013     local($mod, $path, $d, $e);
2014
2015     # reset the global variables:
2016     $HiMapDone = 0;
2017     $HiIncludeString = ();              # dir1:dir2:dir3, to pass to GHC
2018
2019     foreach $d ( @Import_dir ) {
2020         if ($HiIncludeString) {
2021            $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix}";
2022         } else {
2023            $HiIncludeString = "$d%.${HiSuffix}";
2024         }
2025
2026     }
2027
2028     foreach $d ( @SysImport_dir ) {
2029         if ($HiIncludeString) {
2030             $HiIncludeString = "$HiIncludeString:${d}%.${HiSuffix_prelude}";
2031         } else {
2032             $HiIncludeString = "${d}%.${HiSuffix_prelude}";
2033         }
2034     }
2035
2036     $HiMapDone = 1;
2037 }
2038
2039 \end{code}
2040
2041 %************************************************************************
2042 %*                                                                      *
2043 \section[Driver-misc-utils]{Miscellaneous utilities}
2044 %*                                                                      *
2045 %************************************************************************
2046
2047 %************************************************************************
2048 %*                                                                      *
2049 \subsection[Driver-odir-ify]{@odir_ify@: Mangle filename if \tr{-odir} set}
2050 %*                                                                      *
2051 %************************************************************************
2052
2053 \begin{code}
2054 sub osuf_ify {
2055     local($ofile,$def_suffix) = @_;
2056
2057     return(($Osuffix eq '') ? "$ofile.$def_suffix" : "$ofile.$Osuffix" );
2058 }
2059
2060 sub odir_ify {
2061     local($orig_file, $def_suffix) = @_;
2062     if ($Specific_output_dir eq '') {   # do nothing
2063         &osuf_ify($orig_file, $def_suffix);
2064     } else {
2065         local ($orig_file_only);
2066         ($orig_file_only = $orig_file) =~ s|.*/||;
2067         &osuf_ify("$Specific_output_dir/$orig_file_only",$def_suffix);
2068     }
2069 }
2070 \end{code}
2071
2072 \begin{code}
2073 sub runGcc {
2074     local($is_hc_file, $hsc_out, $cc_as_o) = @_;
2075
2076     local($includes) = '-I' . join(' -I', @Include_dir);
2077     local($cc);
2078     local($s_output);
2079     local($c_flags) = "@CcBoth_flags";
2080     local($ddebug_flag) = ( $DEBUGging ) ? '-DDEBUG' : '';
2081
2082     # "input" files to use that are not in some weird directory;
2083     # to help C compilers grok .hc files [ToDo: de-hackify]
2084     local($cc_help)   = "ghc$$.c";
2085     local($cc_help_s) = "ghc$$.s";
2086
2087     $cc       = $CcRegd;
2088     $s_output = (($is_hc_file && $DoAsmMangling) || $TargetPlatform =~ /^(powerpc|rs6000|hppa)/) ? $cc_as_o : $cc_as;
2089     $c_flags .= " @CcRegd_flags";
2090     $c_flags .= ($is_hc_file) ? " @CcRegd_flags_hc"  : " @CcRegd_flags_c";
2091
2092     # C compiler won't like the .hc extension.  So we create
2093     # a tmp .c file which #include's the needful.
2094     open(TMP, "> $cc_help") || &tidy_up_and_die(1,"$Pgm: failed to open `$cc_help' (to write)\n");
2095     if ( $is_hc_file ) {
2096         print TMP <<EOINCL;
2097 #include "Stg.h"
2098 EOINCL
2099         # user may have asked for #includes to be injected...
2100         print TMP @CcInjects if $#CcInjects >= 0;
2101     } else {
2102         # Straight .c files may want to know that they're being used
2103         # with a particular version of GHC, so we define __GLASGOW_HASKELL__ for their benefit.
2104         print TMP "#define __GLASGOW_HASKELL__ ${ProjectVersionInt}\n";
2105     }
2106     # heave in the consistency info
2107     print TMP "static char ghc_cc_ID[] = \"\@(#)cc $ifile\t$Cc_major_version.$Cc_minor_version,$Cc_consist_options\";\n";
2108
2109     print TMP "#include \"$hsc_out\"\n";
2110     close(TMP) || &tidy_up_and_die(1,"Failed writing to $cc_help\n");
2111
2112     # Don't redirect stderr into intermediate file if slamming output onto stdout (e.g., with -E)
2113     local($fuse_stderr) = "2>&1" if ! $Only_preprocess_hc;
2114     local($to_do) = "$cc $Verbose $ddebug_flag $c_flags @Cpp_define $includes $cc_help > $Tmp_prefix.ccout $fuse_stderr && ( if [ $cc_help_s != $s_output ] ; then mv $cc_help_s $s_output ; else exit 0 ; fi )";
2115
2116     if ( $Only_preprocess_hc ) { # HACK ALERT!
2117         $to_do =~ s/ -S\b//g;
2118     }
2119     push(@Files_to_tidy, $cc_help, $cc_help_s, $s_output );
2120     $PostprocessCcOutput = 1 if ! $Only_preprocess_hc;  # hack, dear hack...
2121     &run_something($to_do, 'C compiler');
2122     $PostprocessCcOutput = 0;
2123     if ( $Only_preprocess_hc ) {
2124        system("$Cat $Tmp_prefix.ccout");
2125     }
2126     unlink($cc_help, $cc_help_s);
2127 }
2128 \end{code}
2129
2130 \begin{code}
2131 sub runMangler {
2132     local($is_hc_file, $cc_as_o, $cc_as, $ifile_root) = @_;
2133
2134     print STDERR `cat $cc_as_o` if $Dump_raw_asm; # to stderr, before mangling
2135
2136     if ($is_hc_file && $DoAsmMangling) {
2137         # dynamically load assembler-fiddling code, which we are about to use:
2138         require('ghc-asm.prl')
2139              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm.prl!\n");
2140         # post-process the assembler [.hc files only]
2141         &mangle_asm($cc_as_o, $cc_as);
2142
2143     } elsif ($TargetPlatform =~ /^hppa/) {
2144         # minor mangling of non-threaded files for hp-pa only
2145         require('ghc-asm.prl')
2146         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-hppa.prl!\n");
2147         &mini_mangle_asm_hppa($cc_as_o, $cc_as);
2148
2149     } elsif ($TargetPlatform =~ /^powerpc|^rs6000/) {
2150         # minor mangling of non-threaded files for powerpcs and rs6000s
2151         require('ghc-asm.prl')
2152         || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-asm-powerpc.prl!\n");
2153         &mini_mangle_asm_powerpc($cc_as_o, $cc_as);
2154     }
2155
2156     # save a copy of the .s file, even if we are carrying on...
2157     #if ($do_as && $Keep_s_file_too) {
2158     #    &saveIntermediate($ifile_root , "s" , $cc_as);
2159     #}
2160 }
2161 \end{code}
2162
2163 \begin{code}
2164 sub runAs {
2165     local($as_out, $ifile_root) = @_;
2166
2167     local($asmblr) = ( $As ) ? $As : $CcRegd;
2168
2169     # need to add the -I flags in case the file is going through cpp (.S files)
2170     local($includes) = '-I' . join(' -I', @Include_dir);
2171
2172     if ( ! $SplitObjFiles ) {
2173         local($to_do)  = "$asmblr -o $as_out -c @As_flags $includes $cc_as";
2174         push(@Files_to_tidy, $as_out );
2175         &run_something($to_do, 'Unix assembler');
2176
2177     } else { # more complicated split-ification...
2178
2179         # must assemble files $Tmp_prefix__[1 .. $NoOfSplitFiles].s
2180
2181         # If -odir is used, great, just pin it in front of the
2182         # generated split file names. If it hasn't been set, we
2183         # snatch it from the ifile_root.
2184         #
2185         #
2186
2187         if ( $Specific_output_dir eq '' ) {
2188             $Specific_output_dir = ${ifile_root};
2189         }
2190
2191         for ($f = 1; $f <= $NoOfSplitFiles; $f++ ) {
2192             local($split_out) = &odir_ify("${ifile_root}__${f}",'o');
2193             local($to_do) = "$asmblr -o $split_out -c @As_flags ${Tmp_prefix}__${f}.s";
2194             push(@Files_to_tidy, $split_out );
2195
2196             &run_something($to_do, 'Unix assembler');
2197         }
2198     }
2199 }
2200 \end{code}
2201
2202 %************************************************************************
2203 %*                                                                      *
2204 \subsection[Driver-run-something]{@run_something@: Run a phase}
2205 %*                                                                      *
2206 %************************************************************************
2207
2208 \begin{code}
2209 sub run_something {
2210     local($str_to_do, $tidy_name) = @_;
2211
2212     print STDERR "\n$tidy_name:\n\t" if $Verbose;
2213     print STDERR "$str_to_do\n" if $Verbose;
2214
2215     if ($Using_dump_file) {
2216         open(DUMP, ">> $Specific_dump_file")
2217             || &tidy_up_and_die(1,"$Pgm: failed to open `$Specific_dump_file'\n");
2218         print DUMP "\nCompilation Dump for: $str_to_do\n\n";
2219         close(DUMP)
2220             || &tidy_up_and_die(1,"$Pgm: failed closing `$Specific_dump_file'\n");
2221     }
2222
2223     local($return_val) = 0;
2224
2225     if ( length($str_to_do) > 4000) {
2226       # 4000 - on the random side, just like the *real* ARG_MAX
2227       # for some shells.
2228
2229       # With some shells, command lines of this length may
2230       # very well cause trouble. To safeguard against this, we squirrel the
2231       # command into a file and exec that.
2232       local ($sh) = $ENV{'REAL_SHELL'};
2233       print STDERR "Backup plan A: saving cmd line in ${Tmp_prefix}.sh and executing that with $sh\n" if $Verbose;
2234       open (TEMP, "> ${Tmp_prefix}.sh") ||
2235                 &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.sh'\n");
2236       print TEMP "$Time $str_to_do\n";
2237       close (TEMP) ||
2238                 &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.sh'\n");
2239       system("$sh $Tmp_prefix.sh");
2240       $return_val = $?;
2241
2242       unlink "${Tmp_prefix}.sh";
2243     } else {
2244       system("$Time $str_to_do");
2245       $return_val = $?;
2246     }
2247
2248     if ( $PostprocessCcOutput ) { # hack, continued
2249         open(CCOUT, "< $Tmp_prefix.ccout")
2250             || &tidy_up_and_die(1,"$Pgm: failed to open `$Tmp_prefix.ccout'\n");
2251         while ( <CCOUT> ) {
2252             next if /call-clobbered/;
2253             next if /control reaches end/;
2254             next if /from .*Stg\.h:/;
2255             next if /from ghc\d+.c:\d+:/;
2256             next if /: At top level:$/;
2257             next if /: In function \`.*\':$/;
2258             next if /\`ghc_cc_ID\' defined but not used/;
2259             print STDERR $_;
2260         }
2261         close(CCOUT) || &tidy_up_and_die(1,"$Pgm: failed closing `$Tmp_prefix.ccout'\n");
2262     }
2263
2264     if ($return_val != 0) {
2265         if ($Using_dump_file) {
2266             print STDERR "Compilation Errors dumped in $Specific_dump_file\n";
2267         }
2268         &tidy_up_and_die($return_val, '');
2269     }
2270     $Using_dump_file = 0;
2271 }
2272 \end{code}
2273
2274 %************************************************************************
2275 %*                                                                      *
2276 \subsection[Driver-ghc-timing]{Emit nofibbish GHC timings}
2277 %*                                                                      *
2278 %************************************************************************
2279
2280 NB: nearly the same as in @runstdtest@ script.
2281
2282 \begin{code}
2283 sub process_ghc_timings {
2284     local($StatsFile) = "$Tmp_prefix.stat";
2285     local($SysSpecificTiming) = 'ghc';
2286
2287     open(STATS, $StatsFile) || die "Failed when opening $StatsFile\n";
2288     local($max_live)    = 0;
2289     local($tot_live)    = 0; # for calculating residency stuff
2290     local($tot_samples) = 0;
2291
2292     while (<STATS>) {
2293         if (! /Gen:\s+0/ && ! /Minor/ && /^\s*\d+\s+\d+\s+(\d+)\s+\d+\.\d+/ ) {
2294                 $max_live = $1 if $max_live < $1;
2295                 $tot_live += $1;
2296                 $tot_samples += 1;
2297         }
2298         $BytesAlloc = $1 if /^\s*([0-9,]+) bytes allocated in the heap/;
2299
2300         if ( /^\s*([0-9,]+) bytes maximum residency .* (\d+) sample/ ) {
2301             $MaxResidency = $1; $ResidencySamples = $2;
2302         }
2303
2304         $GCs = $1 if /^\s*([0-9,]+) (collections? in generation 0|garbage collections? performed)/;
2305
2306         if ( /^\s+([0-9]+)\s+Mb total memory/ ) {
2307             $TotMem = $1;
2308         }
2309
2310         # The presence of -? in the following pattern is only there to
2311         # accommodate 0.29 && <= 2.05 RTS'
2312         if ( /^\s*INIT\s+time\s*(\d+\.\d\d)s\s*\(\s*-?(\d+\.\d\d)s elapsed\)/ ) {
2313             $InitTime = $1; $InitElapsed = $2;
2314         } elsif ( /^\s*MUT\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2315             $MutTime = $1; $MutElapsed = $2;
2316         } elsif ( /^\s*GC\s+time\s*(\d+\.\d\d)s\s*\(\s*(\d+\.\d\d)s elapsed\)/ ) {
2317             $GcTime = $1; $GcElapsed = $2;
2318         }
2319     }
2320     close(STATS) || die "Failed when closing $StatsFile\n";
2321     if ( $tot_samples > 0 ) {
2322         $ResidencySamples = $tot_samples;
2323         $MaxResidency = $max_live;
2324         $AvgResidency = int ($tot_live / $tot_samples) ;
2325     }
2326
2327     # warn about what we didn't find
2328     print STDERR "Warning: BytesAlloc not found in stats file\n" unless defined($BytesAlloc);
2329     print STDERR "Warning: GCs not found in stats file\n" unless defined($GCs);
2330     print STDERR "Warning: InitTime not found in stats file\n" unless defined($InitTime);
2331     print STDERR "Warning: InitElapsed not found in stats file\n" unless defined($InitElapsed);
2332     print STDERR "Warning: MutTime not found in stats file\n" unless defined($MutTime);
2333     print STDERR "Warning: MutElapsed not found in stats file\n" unless defined($MutElapsed);
2334     print STDERR "Warning: GcTime inot found in stats file\n" unless defined($GcTime);
2335     print STDERR "Warning: GcElapsed not found in stats file\n" unless defined($GcElapsed);
2336
2337     # things we didn't necessarily expect to find
2338     $MaxResidency     = 0 unless defined($MaxResidency);
2339     $AvgResidency     = 0 unless defined($AvgResidency);
2340     $ResidencySamples = 0 unless defined($ResidencySamples);
2341
2342     # a bit of tidying
2343     $BytesAlloc =~ s/,//g;
2344     $MaxResidency =~ s/,//g;
2345     $GCs =~ s/,//g;
2346     $InitTime =~ s/,//g;
2347     $InitElapsed =~ s/,//g;
2348     $MutTime =~ s/,//g;
2349     $MutElapsed =~ s/,//g;
2350     $GcTime =~ s/,//g;
2351     $GcElapsed =~ s/,//g;
2352
2353     # print out what we found
2354     print STDERR "<<$SysSpecificTiming: ",
2355         "$BytesAlloc bytes, $GCs GCs, $AvgResidency/$MaxResidency avg/max bytes residency ($ResidencySamples samples), ${TotMem}M in use, $InitTime INIT ($InitElapsed elapsed), $MutTime MUT ($MutElapsed elapsed), $GcTime GC ($GcElapsed elapsed)",
2356         " :$SysSpecificTiming>>\n";
2357
2358     # OK, party over
2359     unlink $StatsFile;
2360 }
2361 \end{code}
2362
2363 %************************************************************************
2364 %*                                                                      *
2365 \subsection[Driver-dying]{@tidy_up@ and @tidy_up_and_die@: Dying gracefully}
2366 %*                                                                      *
2367 %************************************************************************
2368
2369 \begin{code}
2370 sub tidy_up {
2371     local($to_do) = "\n$Rm $Tmp_prefix*";
2372     if ( $Tmp_prefix !~ /^\s*$/ ) {
2373         print STDERR "$to_do\n" if $Verbose;
2374         system($to_do);
2375     }
2376 }
2377
2378 sub tidy_up_and_die {
2379     local($return_val, $msg) = @_;
2380
2381     # delete any files to tidy
2382     print STDERR "deleting... @Files_to_tidy\n" if $Verbose && $#Files_to_tidy >= 0;
2383     unlink @Files_to_tidy if $#Files_to_tidy >= 0;
2384
2385     &tidy_up();
2386     print STDERR $msg;
2387     exit (($return_val == 0) ? 0 : 1);
2388 }
2389 \end{code}
2390
2391 %************************************************************************
2392 %*                                                                      *
2393 \subsection[Driver-arg-with-arg]{@grab_arg_arg@: Do an argument with an argument}
2394 %*                                                                      *
2395 %************************************************************************
2396
2397 Some command-line arguments take an argument, e.g.,
2398 \tr{-Rmax-heapsize} expects a number to follow.  This can either be
2399 given a part of the same argument (\tr{-Rmax-heapsize8M}) or as the
2400 next argument (\tr{-Rmax-heapsize 8M}).  We allow both cases.
2401
2402 Note: no error-checking; \tr{-Rmax-heapsize -Rgc-stats} will silently
2403 gobble the second argument (and probably set the heapsize to something
2404 nonsensical).
2405 \begin{code}
2406 sub grab_arg_arg {
2407     local(*Args, $option, $rest_of_arg) = @_;
2408
2409     if ($rest_of_arg ne '') {
2410         return($rest_of_arg);
2411     } elsif ($#Args >= 0) {
2412         local($temp) = $Args[0]; shift(@Args);
2413         return($temp);
2414     } else {
2415         print STDERR "$Pgm: no argument following $option option\n";
2416         $Status++;
2417     }
2418 }
2419 \end{code}
2420
2421 \begin{code}
2422 sub isntAntiFlag {
2423     local($flag) = @_;
2424     local($f);
2425
2426 #Not in HsC_antiflag ## NO!: and not already in HsC_flags
2427
2428     foreach $f ( @HsC_antiflags ) {
2429         return(0) if $flag eq $f;
2430     }
2431 #    foreach $f ( @HsC_flags ) {
2432 #       return(0) if $flag eq $f;
2433 #    }
2434     return(1);
2435 }
2436
2437 sub squashHscFlag {  # pretty terrible
2438     local($flag) = @_;
2439     local($f);
2440
2441     foreach $f ( @HsC_flags ) {
2442         if ($flag eq $f) { $f = ''; }
2443     }
2444 }
2445
2446 sub add_Hsc_flags {
2447     local(@flags) = @_;
2448     local($f);
2449
2450     foreach $f ( @flags ) {
2451         push( @HsC_flags, $f ) if &isntAntiFlag($f);
2452     }
2453 }
2454 \end{code}
2455
2456 To add another system library, you'll need to augment the
2457 Supported_syslibs variable with name and info on your addition
2458 to the syslib family. The info bit consist of the following:
2459
2460    - interface file directory
2461        see the misc or posix entry for how to distinguish
2462        between using installed and build tree directories.
2463
2464    - directory location of archives
2465
2466    - location of (way-independent) C support libs.
2467        not all libraries need this - if you don't, just
2468        give the empty string.
2469    - list of syslibs you depend on.
2470
2471    - additional ghc command line flags that should be used.
2472    - additional C compiler command line flags that should be used.
2473    - link
2474
2475
2476 \begin{code}
2477
2478 # Hash to keep track of
2479 %Syslibs_added = ();
2480
2481 sub add_syslib {
2482     local($syslib) = @_;
2483
2484     # Lifting this out of this sub brings it out of scope - why??
2485     %Supported_syslibs =
2486      ( exts,
2487         [  # where to slurp interface files from
2488           ( $INSTALLING
2489                ? "$InstLibDirGhc/imports/exts"
2490                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2491           )
2492         , # where to find the archive to use when linking
2493           ( $INSTALLING
2494                ? "$InstLibDirGhc"
2495                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/exts"
2496           )
2497         , '' # no cbits
2498         , '' # Syslib dependencies
2499         , '' # extra ghc opts
2500         , '' # extra cc opts
2501         , '' # extra ld opts
2502         ],
2503
2504        misc,
2505         [  # where to slurp interface files from
2506           ( $INSTALLING
2507                ? "$InstLibDirGhc/imports/misc"
2508                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2509           )
2510         , # where to find the archive to use when linking
2511           ( $INSTALLING
2512                ? "$InstLibDirGhc"
2513                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc"
2514           )
2515         , # where to find the cbits archive to use when linking
2516           ( $INSTALLING
2517                ? "$InstLibDirGhc"
2518                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/misc/cbits"
2519           )
2520         , 'exts' # Syslib dependencies
2521         , ''     # extra ghc opts
2522         , ''     # extra cc opts
2523         , ( $TargetPlatform =~ /-solaris2$/  ? '-lnsl -lsocket' : '')
2524         ],
2525        hbc,
2526         [  # where to slurp interface files from
2527           ( $INSTALLING
2528                ? "$InstLibDirGhc/imports/hbc"
2529                : "$TopPwd/CONTRIB/libraries/hbc/src"
2530           )
2531         , # where to find the archive to use when linking
2532           ( $INSTALLING
2533                ? "$InstLibDirGhc"
2534                : "$TopPwd/CONTRIB/libraries/src/hbc"
2535           )
2536         , # where to find the cbits archive to use when linking
2537           ( $INSTALLING
2538                ? "$InstLibDirGhc"
2539                : "$TopPwd/CONTRIB/libraries/hbc/cbits"
2540           )
2541         , 'exts' # Syslib dependencies
2542         , ''     # extra ghc opts
2543         , ''     # extra cc opts
2544         , ''
2545         ],
2546        posix,
2547         [  # where to slurp interface files from
2548           ( $INSTALLING
2549                ? "$InstLibDirGhc/imports/posix"
2550                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2551           )
2552         , # where to find the archive to use when linking
2553           ( $INSTALLING
2554                ? "$InstLibDirGhc"
2555                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix"
2556           )
2557         , # where to find the cbits archive to use when linking
2558           ( $INSTALLING
2559                ? "$InstLibDirGhc"
2560                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/posix/cbits"
2561           )
2562         , 'misc' # Syslib dependencies
2563         , ''     # extra ghc opts
2564         , ''     # extra cc opts
2565         , ''     # extra ld opts
2566         ],
2567        concurrent,
2568         [  # where to slurp interface files from
2569           ( $INSTALLING
2570                ? "$InstLibDirGhc/imports/concurrent"
2571                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2572           )
2573         , # where to find the archive to use when linking
2574           ( $INSTALLING
2575                ? "$InstLibDirGhc"
2576                : "$TopPwd/$CURRENT_DIR/$GHC_LIB_DIR/concurrent"
2577           )
2578         , '' # where to find the cbits archive to use when linking
2579         , '' # Syslib dependencies
2580         , '' # extra ghc opts
2581         , '' # extra cc opts
2582         , '' # extra ld opts
2583         ],
2584        win32,
2585         [  # where to slurp interface files from
2586           ( $INSTALLING
2587                ? "$InstLibDirGhc/imports/win32"
2588                : "$TopPwd/hslibs/win32/src"
2589           )
2590         , # where to find the archive to use when linking
2591           ( $INSTALLING
2592                ? "$InstLibDirGhc"
2593                : "$TopPwd/hslibs/win32/src"
2594           )
2595         , ''
2596         , 'exts' # Syslib dependencies
2597         , ''     # extra ghc opts
2598         , ''     # extra cc opts
2599         , '-luser32 -lgdi32'     # extra ld opts
2600         ]
2601     );
2602
2603     # check if it's supported..
2604
2605     if ( !exists $Supported_syslibs{$syslib} ) {
2606        print STDERR "$Pgm: no such system library (-syslib): $syslib\n";
2607        $Status++;
2608        return;
2609     }
2610
2611     # This check is here to avoid syslib loops from
2612     # spoiling the party. A side-effect of it is that
2613     # it disallows multiple mentions of a syslib on a command-line,
2614     # explicit *and* implicit ones (i.e., "-syslib exts -syslib misc"
2615     # is not equal to "-syslib exts -syslib misc -syslib exts",
2616     # which it needs to be)
2617     #
2618     # Since our current collection of syslibs don't have any
2619     # loops, this test is disabled.
2620     #
2621     # ToDo: loop avoidance scheme when the need arises
2622     #
2623     #return if ( exists $Syslibs_added{$syslib} );
2624
2625     $Syslibs_added{$syslib} = 1;
2626
2627     local ($hi_dir, $lib_dir, $lib_cbits_dir,
2628            $syslib_deps, $syslib_ghc_opts,
2629            $syslib_cc_opts, $syslib_ld_opts) = @{ $Supported_syslibs{$syslib} };
2630
2631
2632     unshift(@SysImport_dir, $hi_dir);
2633     push(@SysLibrary_dir, $lib_dir);
2634     push(@SysLibrary_dir, $lib_cbits_dir) if ( $lib_cbits_dir ne '');
2635
2636     push(@SysLibrary, "-lHS$syslib");
2637     push(@SysLibrary, "-lHS${syslib}_cbits") if ( $lib_cbits_dir ne '');
2638     push(@SysLibrary, $syslib_ld_opts) if ($syslib_ld_opts ne '');
2639
2640     # Add on any extra dependencies.
2641     foreach $lib (split(' ',$syslib_deps)) {
2642       &add_syslib($lib);
2643     }
2644 }
2645 \end{code}
2646
2647 Source files may have {-# OPTIONS ... #-} pragmas at the top, containing
2648 command line options we want to append to collection of commands specified
2649 directly. @check_for_source_options@ looks at the top of a de-lit'ified Haskell
2650 file for any such pragmas:
2651
2652 \begin{code}
2653 sub check_for_source_options {
2654     local($file,$ifile) = @_;
2655     local($comment_start,$comment_end);
2656
2657     if ($ifile =~ /\.hc$/ ||
2658         $ifile =~ /_hc$/  ||
2659         $ifile =~ /\.s$/  ||
2660         $ifile =~ /_s$/ ) {  # `Real' C intermediate
2661        $comment_start = "/\\*";
2662        $comment_end   = "\\*/";
2663     } else { # Assume it is a file containing Haskell source
2664        $comment_start = "{-#";
2665        $comment_end   = "#-}";
2666     }
2667
2668     open(FILE,$file) || return(1); # No big loss
2669
2670     while (<FILE>) {
2671         if ( /^${comment_start} OPTIONS (.*)${comment_end}$/ ) {
2672            # add the options found at the back of the command line.
2673            local(@entries) = split(/\s+/,$1);
2674            print STDERR "Found OPTIONS " . join(' ',@entries) . " in $file\n" if $Verbose;
2675            push(@File_options, @entries);
2676         }
2677         elsif ( /^$/ ) { # ignore empty lines
2678            ;
2679         }
2680         elsif ( /^#line.+$/ ) { # ignore comment lines (unused..ToDo: rm )
2681            ;
2682         }
2683         elsif ( /^{-# LINE.+$/ ) { # ignore line pragmas
2684            ;
2685         }
2686         else { # stop looking, something non-empty / not
2687                # ${comment_start} OPTIONS .. ${comment_end} encountered.
2688             close(FILE);return(0);
2689         }
2690     }
2691     close(FILE);
2692     return(0);
2693 }
2694 \end{code}
2695
2696
2697 We split the initial argv up into three arrays:
2698
2699   - @Cmd_opts
2700   - @Link_file
2701   - @Input_file
2702
2703 the reason for doing so is to be able to deal
2704 with {-# OPTIONS #-} pragma in source files properly.
2705
2706 \begin{code}
2707 sub splitCmdLine {
2708     local(@args) = @_;
2709
2710 arg: while($_ = $args[0]) {
2711     shift(@args);
2712     # sigh, we have to deal with these -option arg specially here.
2713     /^-(tmpdir|odir|ohi|o|isuf|osuf|hisuf|odump|syslib)$/ &&
2714        do { push(@Cmd_opts, $_); push(@Cmd_opts,$args[0]); shift(@args); next arg; };
2715     /^--?./  && do { push(@Cmd_opts, $_); next arg; };
2716
2717     if (/\.([^_]+_)?[oa]$/) {
2718         push(@Link_file, $_);
2719     } else {
2720         push(@Input_file, $_);
2721     }
2722
2723     # input files must exist:
2724     if (! -f $_) {
2725         print STDERR "$Pgm: input file doesn't exist: $_\n";
2726         $Status++;
2727     }
2728   }
2729 }
2730
2731 \end{code}
2732
2733 When saving an intermediate file (.hc or .s) away, we
2734 have to prefix any OPTIONS found in the original source file.
2735
2736 \begin{code}
2737 sub saveIntermediate {
2738   local ($final,$suffix,$tmp)= @_ ;
2739   local ($to_do);
2740
2741   # $final  -- root of where to park ${final}.${suffix}
2742   # $tmp    -- temporary file where hsc put the intermediate file.
2743
2744   # Delete the old file
2745   $to_do = "$Rm ${final}.${suffix}"; &run_something($to_do, "Removing old .${suffix} file");
2746
2747   if ( $#File_options >= 0 ) { # OPTIONS found in Haskell source unit
2748     # Add OPTION comment to the top of the generated .${suffix} file
2749     open(TEMP, "> ${final}.${suffix}") || &tidy_up_and_die(1,"Can't open ${final}.${suffix}\n");
2750     print TEMP "/* OPTIONS " . join(' ',@File_options) . " */\n";
2751     close(TEMP);
2752     print STDERR "Prepending OPTIONS: " . join(' ',@File_options) . " to ${final}.${suffix}\n" if $Verbose;
2753   }
2754   $to_do = "$Cat $tmp  >> ${final}.${suffix}";
2755   &run_something($to_do, "Saving copy of .${suffix} file");
2756
2757 }
2758
2759 \end{code}
2760
2761
2762 Command-line processor
2763
2764 \begin{code}
2765 sub processArgs {
2766     local(@Args) = @_;
2767
2768 # can't use getopt(s); what we want is too complicated
2769
2770 arg: while($_ = $Args[0]) {
2771     shift(@Args);
2772
2773     #---------- help -------------------------------------------------------
2774     if (/^-\?$/ || /^--?help$/) { print $LongUsage; exit $Status; }
2775
2776     #-----------version ----------------------------------------------------
2777     /^--version$/   && do { print STDERR "${ProjectName}, version ${ProjectVersion}, patchlevel ${ProjectPatchLevel}\n"; exit $Status; };
2778
2779     #---------- verbosity and such -----------------------------------------
2780     /^-v$/          && do { $Verbose = '-v'; $Time = 'time'; next arg; };
2781
2782     #---------- what phases are to be run ----------------------------------
2783     /^-(no-)?recomp/        && do { $Do_recomp_chkr = ($1 eq '') ? 1 : 0; next arg; };
2784
2785     /^-cpp$/        && do { $Cpp_flag_set = 1; next arg; };
2786     # change the global default:
2787     # we won't run cat; we'll run the real thing
2788
2789     /^-C$/          && do { $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0; $HscOut = '-C=';
2790                             next arg; };
2791     # stop after generating C
2792
2793     /^-noC$/        && do { $HscOut = '-N='; $ProduceHi = '-nohifile=';
2794                             $Do_cc = 0; $Do_as = 0; $Do_lnkr = 0;
2795                             next arg; };
2796     # leave out actual C generation (debugging) [also turns off interface gen]
2797
2798
2799     /^-hi$/              && do { $HiOnStdout = 1; $ProduceHi = '-hifile='; next arg; };
2800     # _do_ generate an interface; usually used as: -noC -hi
2801     /^-hi-with-(.*)$/    && do { $HiOnStdout = 1; $HiWith .= " $1" ; $ProduceHi = '-hifile='; next arg; };
2802     # limit ourselves to outputting a particular section.
2803
2804     /^-nohi$/       && do { $ProduceHi = '-nohifile='; next arg; };
2805     # don't generate an interface (even if generating C)
2806
2807     /^-hi-diffs$/             && do { $HiDiff_flag  = 'normal'; next arg; };
2808     /^-hi-diffs-with-usages$/ && do { $HiDiff_flag  = 'usages'; next arg; };
2809     /^-no-hi-diffs$/          && do { $HiDiff_flag  = '';       next arg; };
2810     /^-keep-hi-diffs$/        && do { $Keep_HiDiffs = 1; next arg; };
2811
2812     # show/disable diffs if the interface file changes
2813
2814     /^-E$/          && do { push(@CcBoth_flags, '-E');
2815                             $Only_preprocess_C = 1;
2816                             $Do_as = 0; $Do_lnkr = 0; next arg; };
2817     # stop after preprocessing C
2818     /^-M$/          && do { $Only_generate_deps = 1; $Do_as = 0; $Do_lnkr = 0; next arg; };
2819     # only generate dependency information.
2820     /^-S$/          && do { $Do_as = 0; $Do_lnkr = 0; next arg; };
2821     # stop after generating assembler
2822
2823     /^-c$/          && do { $Do_lnkr = 0; next arg; };
2824     # stop after generating .o files
2825
2826     /^-link-chk$/    && do { $LinkChk = 1; next arg; };
2827     /^-no-link-chk$/ && do { $LinkChk = 0; next arg; };
2828     # don't do consistency-checking after a link
2829
2830     /^-tmpdir$/ && do { $Tmp_prefix = &grab_arg_arg(*Args,'-tmpdir', '');
2831                         $Tmp_prefix = "$Tmp_prefix/ghc$$";
2832                         $ENV{'TMPDIR'} = $Tmp_prefix; # for those who use it...
2833                         next arg; };
2834     # use an alternate directory for temp files
2835
2836     #---------- redirect output --------------------------------------------
2837
2838     # -o <file>; applies to the last phase, whatever it is
2839     # "-o -" sends it to stdout
2840     # if <file> has a directory component, that dir must already exist
2841
2842     /^-odir$/       && do { $Specific_output_dir = &grab_arg_arg(*Args,'-odir', '');
2843                             #
2844                             # Hack, of the worst sort: don't do validation of
2845                             # odir argument if you're using -M (dependency generation).
2846                             #
2847                             if ( ! $Only_generate_deps && ! -d $Specific_output_dir) {
2848                                 print STDERR "$Pgm: -odir: no such directory: $Specific_output_dir\n";
2849                                 $Status++;
2850                             }
2851                             next arg; };
2852
2853     /^-o$/          && do { $Specific_output_file = &grab_arg_arg(*Args,'-o', '');
2854                             if ($Specific_output_file ne '-'
2855                              && $Specific_output_file =~ /(.*)\/[^\/]*$/) {
2856                                 local($dir_part) = $1;
2857                                 if (! -d $dir_part) {
2858                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2859                                     $Status++;
2860                                 }
2861                             }
2862                             next arg; };
2863
2864     # NB: -isuf not documented yet (because it doesn't work yet)
2865     /^-isuf$/       && do { $Isuffix  = &grab_arg_arg(*Args,'-isuf', '');
2866                             if ($Isuffix =~ /\./ ) {
2867                                 print STDERR "$Pgm: -isuf suffix shouldn't contain a .\n";
2868                                 $Status++;
2869                             }
2870                             next arg; };
2871
2872     /^-osuf$/       && do { $Osuffix  = &grab_arg_arg(*Args,'-osuf', '');
2873                             if ($Osuffix =~ /\./ ) {
2874                                 print STDERR "$Pgm: -osuf suffix shouldn't contain a .\n";
2875                                 $Status++;
2876                             }
2877                             next arg; };
2878
2879     # -ohi <file>; send the interface to <file>; "-ohi -" to send to stdout
2880     /^-ohi$/        && do { $Specific_hi_file = &grab_arg_arg(*Args,'-ohi', '');
2881                             if ($Specific_hi_file ne '-'
2882                              && $Specific_hi_file =~ /(.*)\/[^\/]*$/) {
2883                                 local($dir_part) = $1;
2884                                 if (! -d $dir_part) {
2885                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2886                                     $Status++;
2887                                 }
2888                             }
2889                             next arg; };
2890
2891     # The suffix to use when looking for interface files
2892     /^-hisuf$/      && do { $HiSuffix = &grab_arg_arg(*Args,'-hisuf', '');
2893                             if ($HiSuffix =~ /\./ ) {
2894                                 print STDERR "$Pgm: -hisuf suffix shouldn't contain a .\n";
2895                                 $Status++;
2896                             }
2897                             next arg; };
2898     /^-odump$/      && do { $Specific_dump_file = &grab_arg_arg(*Args,'-odump', '');
2899                             if ($Specific_dump_file =~ /(.*)\/[^\/]*$/) {
2900                                 local($dir_part) = $1;
2901                                 if (! -d $dir_part) {
2902                                     print STDERR "$Pgm: no such directory: $dir_part\n";
2903                                     $Status++;
2904                                 }
2905                             }
2906                             next arg; };
2907
2908     #-------------- scc & Profiling Stuff ----------------------------------
2909
2910     /^-prof$/ && do { $PROFing = 'p'; next arg; }; # profiling -- details later!
2911
2912     /^-auto/ && do {
2913                 # generate auto SCCs on top level bindings
2914                 # -auto-all = all top level bindings
2915                 # -auto     = only top level exported bindings
2916                 $PROFauto = ( /-all/ )
2917                             ? '-fauto-sccs-on-all-toplevs'
2918                             : '-fauto-sccs-on-exported-toplevs';
2919                 next arg; };
2920
2921     /^-caf-all/ && do { # generate individual CAF SCC annotations
2922                 $PROFcaf = '-fauto-sccs-on-individual-cafs';
2923                 next arg; };
2924
2925     /^-ignore-scc$/ && do {
2926                 # forces ignore of scc annotations even if profiling
2927                 $PROFignore_scc = '-W';
2928                 next arg; };
2929
2930     /^-G(.*)$/  && do { push(@HsC_flags, "-G=$1");   # set group for cost centres
2931                         next arg; };
2932
2933     /^-unprof-scc-auto/ && do {
2934                 # generate auto SCCs on top level bindings when not profiling.
2935                 # Used to measure optimisation effects of presence of sccs.
2936                 $UNPROFscc_auto = ( /-all/ )
2937                             ? '-fauto-sccs-on-all-toplevs'
2938                             : '-fauto-sccs-on-exported-toplevs';
2939                 next arg; };
2940
2941     #--------- ticky/parallel ----------------------------------------------
2942     # we sort out the details a bit later on
2943
2944     /^-gransim$/    && do { $GRANing   = 'g'; &add_syslib('concurrent'); next arg; }; # GranSim
2945     /^-ticky$/      && do { $TICKYing  = 't'; next arg; }; # ticky-ticky
2946     /^-parallel$/   && do { $PARing    = 'p'; &add_syslib('concurrent'); next arg; }; # parallel Haskell
2947
2948     #-------------- "user ways" --------------------------------------------
2949
2950     (/^-user-setup-([a-oA-Z])$/ ) &&
2951            do {
2952                 /^-user-setup-([a-oA-Z])$/  && do { $BuildTag = "_$1"; };
2953
2954                 local($stuff) = $UserSetupOpts{$BuildTag};
2955                 local(@opts)  = split(/\s+/, $stuff);
2956
2957                 # feed relevant ops into the arg-processing loop (if any)
2958                 unshift(@Args, @opts) if $#opts >= 0;
2959
2960                 next arg; };
2961
2962     #---------- set search paths for libraries and things ------------------
2963
2964     # we do -i just like HBC (-i clears the list; -i<colon-separated-items>
2965     # prepends the items to the list); -I is for including C .h files.
2966
2967     /^-i$/          && do { @Import_dir = ();  # import path cleared!
2968                             @SysImport_dir = ();
2969                             print STDERR "WARNING: import paths cleared by `-i'\n";
2970                             next arg; };
2971
2972     /^-i(.*)/       && do { local(@new_items)
2973                               = split( /:/, &grab_arg_arg(*Args,'-i', $1));
2974                             unshift(@Import_dir, @new_items);
2975                             next arg; };
2976
2977     /^-I(.*)/       && do { push(@Include_dir,     &grab_arg_arg(*Args,'-I', $1)); next arg; };
2978     /^-L(.*)/       && do { push(@UserLibrary_dir, &grab_arg_arg(*Args,'-L', $1)); next arg; };
2979     /^-l(.*)/       && do { push(@UserLibrary,'-l'.&grab_arg_arg(*Args,'-l', $1)); next arg; };
2980
2981     /^-syslib(.*)/  && do { local($syslib) = &grab_arg_arg(*Args,'-syslib',$1);
2982                             &add_syslib($syslib);
2983                             next arg; };
2984
2985     #=======================================================================
2986     # various flags that we can harmlessly send to one program or another
2987     # (we will later "reclaim" some of the compiler ones now sent to gcc)
2988     #=======================================================================
2989
2990     #---------- this driver itself (ghc) -----------------------------------
2991     # these change what executable is run for each phase:
2992     /^-pgmL(.*)$/   && do { $Unlit      = $1; next arg; };
2993     /^-pgmP(.*)$/   && do { $HsCpp      = $1; next arg; };
2994     /^-pgmC(.*)$/   && do { $HsC        = $1; next arg; };
2995     /^-pgmcO?(.*)$/ && do { $CcRegd     = $1; next arg; }; # the O? for back compat
2996     /^-pgma(.*)$/   && do { $As         = $1; next arg; };
2997     /^-pgml(.*)$/   && do { $Lnkr       = $1; next arg; };
2998     /^-pgmdep(.*)$/ && do { $MkDependHS = $1; next arg; };
2999
3000     #---------- the get-anything-through opts (all pgms) -------------------
3001     # these allow arbitrary option-strings to go to any phase:
3002     /^-optL(.*)$/   && do { push(@Unlit_flags,      $1); next arg; };
3003     /^-optP(.*)$/   && do { push(@HsCpp_flags,      $1); next arg; };
3004     /^-optCrts(.*)$/&& do { push(@HsC_rts_flags,    $1); next arg; };
3005     /^-optC(.*)$/   && do { push(@HsC_flags,        $1); next arg; };
3006     /^-optp(.*)$/   && do { push(@HsP_flags,        $1); next arg; };
3007     /^-optcpp(.*)$/ && do { push(@Cpp_define,       $1); $Only_preprocess_hc = ($1 eq "-E"); next arg; };
3008     /^-optc(.*)$/   && do { push(@CcBoth_flags,     $1); next arg; };
3009     /^-opta(.*)$/   && do { push(@As_flags,         $1); next arg; };
3010     /^-optl(.*)$/   && do { push(@Ld_flags,         $1); next arg; };
3011     /^-optdep(.*)$/ && do { push(@MkDependHS_flags, $1); next arg; };
3012
3013     #---------- Haskell C pre-processor (hscpp) ----------------------------
3014     /^-D(.*)/       && do { push(@HsCpp_flags, "'-D".&grab_arg_arg(*Args,'-D',$1)."'"); next arg; };
3015     /^-U(.*)/       && do { push(@HsCpp_flags, "'-U".&grab_arg_arg(*Args,'-U',$1)."'"); next arg; };
3016
3017     #---------- post-Haskell "assembler"------------------------------------
3018     /^-ddump-raw-asm$/            && do { $Dump_raw_asm        = 1; next arg; };
3019     /^-ddump-asm-splitting-info$/ && do { $Dump_asm_splitting_info = 1; next arg; };
3020
3021     #---------- Haskell compiler (hsc) -------------------------------------
3022
3023     /^-keep-hc-files?-too$/     && do { $Keep_hc_file_too = 1; next arg; };
3024     /^-keep-s-files?-too$/      && do { $Keep_s_file_too = 1;  next arg; };
3025
3026     /^-fignore-interface-pragmas$/ && do { push(@HsC_flags, $_); next arg; };
3027
3028     /^-fno-implicit-prelude$/      && do { $NoImplicitPrelude= 1; push(@HsC_flags, $_); next arg; };
3029
3030      #
3031      # have the compiler proper generate concurrent code,
3032      # really only used when you want to configure your own
3033      # special user compilation way.
3034      #
3035      # (ditto for -fgransim, fscc-profiling, -fparallel and -fticky-ticky)
3036      #
3037     /^-fscc-profiling$/   && do { push(@HsC_flags,$_); next arg; };
3038     /^-fticky-ticky$/     && do { push(@HsC_flags,$_); next arg; };
3039     /^-fgransim$/         && do { push(@HsC_flags,$_); next arg; };
3040     /^-fparallel$/        && do { push(@HsC_flags,$_); next arg; };
3041
3042     /^-split-objs$/     && do {
3043                         if ( $TargetPlatform !~ /^(alpha|hppa1\.1|i386|m68k|mips|powerpc|rs6000|sparc)-/ ) {
3044                             $SplitObjFiles = 0;
3045                             print STDERR "WARNING: don't know how to split objects on this platform: $TargetPlatform\n`-split-objs' option ignored\n";
3046                         } else {
3047                             $SplitObjFiles = 1;
3048                             $HscOut = '-C=';
3049
3050                             push(@HsC_flags, "-fglobalise-toplev-names");
3051                             push(@CcBoth_flags, '-DUSE_SPLIT_MARKERS');
3052
3053                             require('ghc-split.prl')
3054                              || &tidy_up_and_die(1,"$Pgm: panic: can't load ghc-split.prl!\n");
3055                         }
3056                         next arg; };
3057
3058     /^-fno-asm-mangling$/ && do { $DoAsmMangling = 0; next arg; };
3059
3060     /^-fallow-overlapping-instances$/ && do { push(@HsC_flags, $_); next arg; };
3061     /^-fallow-undecidable-instances$/ && do { push(@HsC_flags, $_); next arg; };
3062     /^-fglasgow-exts$/
3063                 && do { push(@HsC_flags, $_);
3064                         push(@HsP_flags, '-N');
3065
3066                         # -fglasgow-exts implies -syslib exts
3067                         &add_syslib('exts');
3068
3069                         next arg; };
3070
3071     /^-fspeciali[sz]e$/
3072                 && do { $Oopt_DoSpecialise = '-fspecialise'; next arg; };
3073     /^-fno-speciali[sz]e$/
3074                 && do { $Oopt_DoSpecialise = ''; next arg; };
3075
3076
3077 # Now the foldr/build options, which are *on* by default (for -O).
3078
3079     /^-ffoldr-build$/
3080                     && do { $Oopt_FoldrBuild = 1;
3081                             $Oopt_FB_Support = '-fdo-arity-expand';
3082                             #print "Yes F/B\n";
3083                             next arg; };
3084
3085     /^-fno-foldr-build$/
3086                     && do { $Oopt_FoldrBuild = 0;
3087                             $Oopt_FB_Support = '';
3088                             next arg; };
3089
3090     /^-fno-foldr-build-rule$/
3091                     && do { $Oopt_FoldrBuild = 0;
3092                             next arg; };
3093
3094     /^-fno-enable-tech$/
3095                     && do { $Oopt_FB_Support = '';
3096                             next arg; };
3097
3098     /^-fno-snapback-to-append$/
3099                     && do { $Oopt_FoldrBuildInline .= ' -fdo-not-fold-back-append ';
3100                             next arg; };
3101
3102     # --------------- Renamer -------------
3103
3104
3105     /^-fno-prune-tydecls$/     && do { push(@HsC_flags, $_); next arg; };
3106     /^-fno-prune-instdecls$/     && do { push(@HsC_flags, $_); next arg; };
3107
3108     # ---------------
3109
3110     /^-fasm-(.*)$/  && do { $HscOut = '-S='; next arg; }; # force using nativeGen
3111     /^-fvia-[cC]$/          && do { $HscOut = '-C='; next arg; }; # force using C compiler
3112
3113     # ---------------
3114
3115     /^-funfolding-.*$/
3116                     && do { push(@HsC_flags, $_); next arg };
3117
3118     /^-funfold-casms-in-hi-file$/
3119                     && do { push(@HsC_flags, $_); next arg };
3120
3121     /^(-fmax-simplifier-iterations)(.*)$/
3122                     && do { $Oopt_MaxSimplifierIterations = $1 . &grab_arg_arg(*Args,$1, $2);
3123                             next arg; };
3124
3125     /^-fno-pedantic-bottoms$/
3126                     && do { $Oopt_PedanticBottoms = ''; next arg; };
3127
3128     /^-fno-pre-inlining$/
3129                     && do { push(@HsC_flags, $_); next arg };
3130
3131     /^-fdo-monad-eta-expansion$/
3132                     && do { $Oopt_MonadEtaExpansion = $_; next arg; };
3133
3134     /^-fno-let-from-(case|app|strict-let)$/ # experimental, really (WDP 95/10)
3135                     && do { push(@HsC_flags, $_); next arg; };
3136
3137     # --------------- Warnings etc. ------
3138
3139     /^-fwarn-(.*)$/      && do { push(@HsC_flags, $_); next arg; };
3140
3141     /^-fno-(.*)$/   && do { push(@HsC_antiflags, "-f$1");
3142                             &squashHscFlag("-f$1");
3143                             next arg; };
3144
3145     /^-W$/          && do { push(@HsC_flags, @MinusWOpts); next arg; };
3146     /^-Wall$/       && do { push(@HsC_flags, @MinusWallOpts); next arg; };
3147     /^(-Wnot|w)$/   && do { foreach (@Hsc_flags) {
3148                                 /^-fwarn-(.*)$/ && do { $_=''; };
3149                             };
3150                             push(@HsC_antiflags, @StandardWarnings);
3151                             next arg; };
3152
3153     # --------------- fun stuff ----------------
3154
3155     /^-freport-compile$/ && do { push(@HsC_flags, $_); next arg; };
3156
3157     # --------------- platform specific flags (for gcc mostly) ----------------
3158
3159     /^-mlong-calls$/ && do { # for GCC for HP-PA boxes,
3160                              # for 2.6.x..?, does not apply for 2.7.2
3161                              # any longer.
3162                             unshift(@CcBoth_flags, ( $_ ));
3163                             next arg; };
3164
3165     /^-m(v8|sparclite|cypress|supersparc|cpu=(cypress|supersparc))$/
3166                      && do { # for GCC for SPARCs
3167                             unshift(@CcBoth_flags, ( $_ ));
3168                             next arg; };
3169
3170     /^-monly-([432])-regs/ && do { # for iX86 boxes only; no effect otherwise
3171                             $StolenX86Regs = $1;
3172                             next arg; };
3173
3174     #*************** ... and lots of debugging ones (form: -d* )
3175
3176     # -d(no-)core-lint is done this way so it is turn-off-able.
3177     /^-dcore-lint/       && do { $CoreLint = '-dcore-lint'; next arg; };
3178     /^-dno-core-lint/    && do { $CoreLint = '';            next arg; };
3179     # Ditto for STG lint
3180     /^-dstg-lint/       && do { $StgLint = '-dstg-lint'; next arg; };
3181     /^-dno-stg-lint/    && do { $StgLint = '';           next arg; };
3182
3183     /^-d(dump|ppr)-/         && do { push(@HsC_flags, $_); next arg; };
3184     /^-dverbose-(simpl|stg)/ && do { push(@HsC_flags, $_); next arg; };
3185     /^-dshow-passes/         && do { push(@HsC_flags, $_); next arg; };
3186     /^-dshow-rn-stats/       && do { push(@HsC_flags, $_); next arg; };
3187     /^-dshow-rn-trace/       && do { push(@HsC_flags, $_); next arg; };
3188     /^-dsource-stats/        && do { push(@HsC_flags, $_); next arg; };
3189     /^-dsimplifier-stats/    && do { push(@HsC_flags, $_); next arg; };
3190     /^-dstg-stats/           && do { $Oopt_StgStats = $_; next arg; };
3191
3192     #*************** ... and now all these -R* ones for its runtime system...
3193
3194     /^-Rscale-sizes?(.*)/ && do {
3195         $Scale_sizes_by = &grab_arg_arg(*Args,'-Rscale-sizes', $1);
3196         next arg; };
3197
3198     /^(-H|-Rmax-heapsize)(.*)/ && do {
3199         local($heap_size) = &grab_arg_arg(*Args,$1, $2);
3200         if ($heap_size =~ /(\d+)[Kk]$/) {
3201             $heap_size = $1 * 1000;
3202         } elsif ($heap_size =~ /(\d+)[Mm]$/) {
3203             $heap_size = $1 * 1000 * 1000;
3204         } elsif ($heap_size =~ /(\d+)[Gg]$/) {
3205             $heap_size = $1 * 1000 * 1000 * 1000;
3206         }
3207         if ($heap_size <= 0) {
3208             print STDERR "$Pgm: resetting heap-size to zero!!! $heap_size\n";
3209             $Specific_heap_size = 0;
3210
3211         # if several heap sizes given, take the largest...
3212         } elsif ($heap_size >= $Specific_heap_size) {
3213             $Specific_heap_size = $heap_size;
3214         } else {
3215             print STDERR "$Pgm: ignoring heap-size-setting option ($_)...not the largest seen\n";
3216         }
3217         next arg; };
3218
3219     /^(-K|Rmax-(stk|stack)size)(.*)/ && do {
3220         local($flag) = $1;
3221         local($stk_size) = &grab_arg_arg(*Args,'-Rmax-stksize', $3);
3222         if ($stk_size =~ /(\d+)[Kk]$/) {
3223             $stk_size = $1 * 1000;
3224         } elsif ($stk_size =~ /(\d+)[Mm]$/) {
3225             $stk_size = $1 * 1000 * 1000;
3226         } elsif ($stk_size =~ /(\d+)[Gg]$/) {
3227             $stk_size = $1 * 1000 * 1000 * 1000;
3228         }
3229         if ($stk_size <= 0) {
3230             print STDERR "$Pgm: resetting stack-size to zero!!! $stk_size\n";
3231             $Specific_stk_size = 0;
3232
3233         # if several stack sizes given, take the largest...
3234         } elsif ($stk_size >= $Specific_stk_size) {
3235             $Specific_stk_size = $stk_size;
3236         } else {
3237             print STDERR "$Pgm: ignoring stack-size-setting option ($flag $stk_size)...not the largest seen\n";
3238         }
3239         next arg; };
3240
3241     /^-Rgc-stats$/ && do {  $CollectingGCstats++;
3242                             # the two RTSs do this diff ways; we will try to compensate
3243                             next arg; };
3244
3245     /^-Rghc-timing/ && do { $CollectGhcTimings = 1; next arg; };
3246
3247     #---------- C high-level assembler (gcc) -------------------------------
3248     /^-(Wall|ansi|pedantic)$/ && do { push(@CcBoth_flags, $_); next arg; };
3249
3250     # -dgcc-lint is a useful way of making GCC very fussy.
3251     # From alan@spri.levels.unisa.edu.au (Alan Modra).
3252     /^-dgcc-lint$/ && do { push(@CcBoth_flags, '-Wall -Wpointer-arith -Wbad-function-cast -Wcast-qual -Wstrict-prototypes -Wmissing-prototypes -Wmissing-declarations -Wnested-externs'); next arg; };
3253     # An alternate set, from mark@sgcs.com (Mark W. Snitily)
3254     # -Wall -Wstrict-prototypes -Wmissing-prototypes -Wcast-align -Wshadow
3255
3256     # inject "#include <wurble>" into the compiler's C output!
3257
3258     /^-#include(.*)/    && do {
3259         local($to_include) = &grab_arg_arg(*Args,'-#include', $1);
3260         push(@CcInjects, "#include $to_include\n");
3261         next arg; };
3262
3263     #---------- Linker (gcc, really) ---------------------------------------
3264
3265     /^-static$/         && do { push(@HsC_flags, $_); push(@Ld_flags, $_); next arg; };
3266     /^-no-hs-main$/     && do { $NoHaskellMain=1; next arg;    };
3267
3268     #---------- mixed cc and linker magic ----------------------------------
3269     # this optimisation stuff is finally sorted out later on...
3270
3271     /^-O2-for-C$/ && do { $MinusO2ForC = 1; next arg; };
3272
3273     /^-O[1-2]?$/ && do {
3274                 local($opt_lev) = ( /^-O2$/ ) ? 2 : 1; # max 'em
3275                 $OptLevel = ( $opt_lev > $OptLevel ) ? $opt_lev : $OptLevel;
3276
3277                 $HscOut = '-C=' if $OptLevel == 2; # force use of C compiler
3278                 next arg; };
3279
3280     /^-Onot$/   && do { $OptLevel = 0; next arg; }; # # set it to <no opt>
3281
3282     /^-Ofile(.*)/ && do {
3283                 $OptLevel = 3;
3284                 local($ofile) = &grab_arg_arg(*Args,'-Ofile', $1);
3285                 @HsC_minusO3_flags = ();
3286
3287                 open(OFILE, "< $ofile") || die "Can't open $ofile!\n";
3288                 while (<OFILE>) {
3289                     chop;
3290                     s/\#.*//;       # death to comments
3291                     s/[ \t]+//g;    # death to whitespace
3292                     next if /^$/;   # ditto, blank lines
3293                     s/([()*{}])/\\$1/g;    # protect shell metacharacters
3294                     if ( /^C:(.*)/ ) {
3295                         push(@CcBoth_flags, $1);
3296                     } else {
3297                         push(@HsC_minusO3_flags, $_);
3298                     }
3299                 }
3300                 close(OFILE);
3301                 next arg; };
3302
3303     /^-debug$/  && do { # all this does is mark a .hc/.o as "debugging"
3304                         # in the consistency info
3305                         $DEBUGging = 'd';
3306                         next arg; };
3307
3308     #---------- linking .a file --------------------------------------------
3309
3310     /^-Main(.*)/ && do {
3311                 # specifies main or mainPrimIO to be linked
3312                 $Ld_main = $1;
3313                 next arg; };
3314
3315     #---------- catch unrecognized flags -----------------------------------
3316
3317     /^-./ && do {
3318         print STDERR "$Pgm: unrecognised option: $_\n";
3319         $Status++;
3320         next arg; };
3321
3322 }
3323
3324 } # end of processArgs
3325
3326 \end{code}