ghc/driver/ghc.lprl

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