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