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